Uat signoff

[nitish-egov]

No description provided.

[coderabbitai]

Walkthrough

Walkthrough

The recent updates focus on enhancing the functionality and readability of boundary-related operations within the project. Key changes include refining logic for generating boundary codes, improving error handling, and updating function signatures to incorporate new parameters. Additionally, utility functions have been expanded, and validation processes have been strengthened to ensure data integrity.

Changes

File Path	Change Summary
.../src/server/api/genericApis.ts	Modified function signatures for getAutoGeneratedBoundaryCodesHandler, getAutoGeneratedBoundaryCodes, createBoundaryEntities, and createBoundaryRelationship. Enhanced logic for boundary codes and error handling.
.../src/server/utils/genericUtils.ts	Added getDifferentDistrictTabs function to process boundaryData and extract unique district tabs.
.../src/server/validators/campaignValidators.ts	Updated validateTabsWithTargetInTargetSheet and immediateValidationForTargetSheet to incorporate new parameters and logic. Added validateAllDistrictTabsPresentOrNot function.

🐇
In the land of code, where boundaries lie,
Functions evolve, and errors say goodbye.
Maps and lists, they intertwine,
Making sure the data aligns.
With tabs and sheets, districts found,
The project’s now on solid ground.
Hooray for changes, hip-hip-hooray,
A rabbit's work, done for today! 🌟

---

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a5e03fe and cde797b.

Files selected for processing (3)

• utilities/project-factory/src/server/api/genericApis.ts (9 hunks)
• utilities/project-factory/src/server/utils/genericUtils.ts (2 hunks)
• utilities/project-factory/src/server/validators/campaignValidators.ts (4 hunks)

Additional comments not posted (5)

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

551-594: Review the logic for generating boundary codes in getAutoGeneratedBoundaryCodes.

The logic for generating boundary codes seems complex and involves multiple maps and checks. It's crucial to ensure that all edge cases are handled, especially with maps that might not have the expected keys. Consider adding more robust error handling and possibly unit tests to cover various scenarios.

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

8-8: Import of getDifferentDistrictTabs added.

This import aligns with the changes described in the PR summary and is necessary for the new validation functions introduced.

---

418-427: Validation logic in validateTabsWithTargetInTargetSheet correctly checks sheet headers.

The function effectively compares the expected headers with the actual headers in the target sheet and throws an error if they do not match. This is crucial for ensuring data consistency and correctness.

---

996-1011: Validation of district tabs in validateAllDistrictTabsPresentOrNot is implemented correctly.

The function ensures that all required district tabs are present in the target sheet, which is essential for maintaining data integrity and completeness.

---

971-978: Immediate validation logic in immediateValidationForTargetSheet is robust.

The function checks for common data issues such as empty sheets and invalid columns, which helps prevent data quality issues early in the process.

[coderabbitai]

Ensure robust error handling for data format issues in getDifferentDistrictTabs.

Consider adding error handling to manage cases where differentTabsBasedOnLevel might not exist in some data objects, or where data might not be an array of objects as expected. This will prevent runtime errors and improve the function's robustness.

[coderabbitai]

Ensure proper error handling in getAutoGeneratedBoundaryCodesHandler.

The error handling in this function logs the error but also rethrows it. This could lead to unhandled promise rejections if not properly caught in the calling function. Consider handling the error more gracefully or ensuring that all callers are prepared to handle the thrown error.

[coderabbitai]

Simplify and ensure robust error handling in createBoundaryRelationship.

This function contains deeply nested logic and multiple levels of error handling which can be simplified. Consider refactoring to reduce complexity and improve error clarity. Additionally, ensure that all potential errors are handled appropriately and that error messages are descriptive enough to aid in debugging.

- throwError("COMMON", 500, errorCode, errorMessage);
+ throwError("COMMON", 500, "BOUNDARY_RELATIONSHIP_CREATION_FAILED", "Failed to create boundary relationship due to: " + errorMessage);

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	try {
	const boundaryRelationshipResponse = await httpRequest(url, request.body, params);
	const boundaryData = boundaryRelationshipResponse?.TenantBoundary?.[0]?.boundary;
	const allCodes = extractCodesFromBoundaryRelationshipResponse(boundaryData);
	let flag = 1;
	for (const { key: boundaryCode, value: boundaryType } of updatedBoundaryMap) {
	if (!allCodes.has(boundaryCode)) {
	const boundary = {
	tenantId: request?.body?.ResourceDetails?.tenantId,
	boundaryType: boundaryType,
	code: boundaryCode,
	hierarchyType: request?.body?.ResourceDetails?.hierarchyType,
	parent: modifiedChildParentMap.get(boundaryCode) ? modifiedChildParentMap.get(boundaryCode) : null
	};
	flag = 0;
	requestBody.BoundaryRelationship = boundary;
	// Introducing a delay of 1 second
	await new Promise(resolve => setTimeout(resolve, 1000));
	try {
	const response = await httpRequest(`${config.host.boundaryHost}${config.paths.boundaryRelationshipCreate}`, requestBody, {}, 'POST', undefined, undefined, true);
	if (!response.TenantBoundary || !Array.isArray(response.TenantBoundary) || response.TenantBoundary.length === 0) {
	throwError("BOUNDARY", 500, "BOUNDARY_RELATIONSHIP_CREATE_ERROR");
	}
	logger.info(`Boundary relationship created for boundaryType :: ${boundaryType} & boundaryCode :: ${boundaryCode} `);
	const newRequestBody = JSON.parse(JSON.stringify(request.body));
	activityMessage.push(await generateActivityMessage(request?.body?.ResourceDetails?.tenantId, request.body, newRequestBody, response, request?.body?.ResourceDetails?.type, url, response?.statusCode));
	} catch (error) {
	// Log the error and rethrow to be caught by the outer try...catch block
	logger.error(`Error creating boundary relationship for boundaryType :: ${boundaryType} & boundaryCode :: ${boundaryCode} :: `, error);
	throw error;
	}
	}
	const updatedBoundaryMap: Array<{ key: string, value: string }> = Array.from(boundaryMap).map(([key, value]) => ({ key: value, value: key.key }));
	let activityMessage: any[] = [];
	const requestBody = { "RequestInfo": request.body.RequestInfo } as { RequestInfo: any; BoundaryRelationship?: any };
	const url = `${config.host.boundaryHost}${config.paths.boundaryRelationship}`;
	const params = {
	"type": request?.body?.ResourceDetails?.type,
	"tenantId": request?.body?.ResourceDetails?.tenantId,
	"boundaryType": null,
	"codes": null,
	"includeChildren": true,
	"hierarchyType": request?.body?.ResourceDetails?.hierarchyType
	};
	const boundaryRelationshipResponse = await httpRequest(url, request.body, params);
	const boundaryData = boundaryRelationshipResponse?.TenantBoundary?.[0]?.boundary;
	const allCodes = extractCodesFromBoundaryRelationshipResponse(boundaryData);
	let flag = 1;
	for (const { key: boundaryCode, value: boundaryType } of updatedBoundaryMap) {
	if (!allCodes.has(boundaryCode)) {
	const boundary = {
	tenantId: request?.body?.ResourceDetails?.tenantId,
	boundaryType: boundaryType,
	code: boundaryCode,
	hierarchyType: request?.body?.ResourceDetails?.hierarchyType,
	parent: modifiedChildParentMap.get(boundaryCode) ? modifiedChildParentMap.get(boundaryCode) : null
	};
	if (flag === 1) {
	throwError("COMMON", 400, "VALIDATION_ERROR", "Boundary already present in the system");
	flag = 0;
	requestBody.BoundaryRelationship = boundary;
	// Introducing a delay of 1 second
	await new Promise(resolve => setTimeout(resolve, 1000));
	try {
	const response = await httpRequest(`${config.host.boundaryHost}${config.paths.boundaryRelationshipCreate}`, requestBody, {}, 'POST', undefined, undefined, true);
	if (!response.TenantBoundary || !Array.isArray(response.TenantBoundary) || response.TenantBoundary.length === 0) {
	throwError("BOUNDARY", 500, "BOUNDARY_RELATIONSHIP_CREATE_ERROR");
	}
	logger.info(`Boundary relationship created for boundaryType :: ${boundaryType} & boundaryCode :: ${boundaryCode} `);
	const newRequestBody = JSON.parse(JSON.stringify(request.body));
	activityMessage.push(await generateActivityMessage(request?.body?.ResourceDetails?.tenantId, request.body, newRequestBody, response, request?.body?.ResourceDetails?.type, url, response?.statusCode));
	} catch (error) {
	// Log the error and rethrow to be caught by the outer try...catch block
	logger.error(`Error creating boundary relationship for boundaryType :: ${boundaryType} & boundaryCode :: ${boundaryCode} :: `, error);
	throw error;
	}
	}
	};
	request.body = {
	...request.body,
	Activities: activityMessage
	};
	} catch (error: any) {
	const errorCode = error.code || "INTERNAL_SERVER_ERROR";
	const errorMessage = error.description || "Error while boundary relationship create";
	logger.error(`Error in createBoundaryRelationship: ${errorMessage}`, error);
	throwError("COMMON", 500, errorCode, errorMessage);
	if (flag === 1) {
	throwError("COMMON", 400, "VALIDATION_ERROR", "Boundary already present in the system");
	}
	request.body = {
	...request.body,
	Activities: activityMessage
	};
	} catch (error: any) {
	const errorCode = error.code || "INTERNAL_SERVER_ERROR";
	const errorMessage = error.description || "Error while boundary relationship create";
	logger.error(`Error in createBoundaryRelationship: ${errorMessage}`, error);
	throwError("COMMON", 500, errorCode, errorMessage);
	}
	try {
	const updatedBoundaryMap: Array<{ key: string, value: string }> = Array.from(boundaryMap).map(([key, value]) => ({ key: value, value: key.key }));
	let activityMessage: any[] = [];
	const requestBody = { "RequestInfo": request.body.RequestInfo } as { RequestInfo: any; BoundaryRelationship?: any };
	const url = `${config.host.boundaryHost}${config.paths.boundaryRelationship}`;
	const params = {
	"type": request?.body?.ResourceDetails?.type,
	"tenantId": request?.body?.ResourceDetails?.tenantId,
	"boundaryType": null,
	"codes": null,
	"includeChildren": true,
	"hierarchyType": request?.body?.ResourceDetails?.hierarchyType
	};
	const boundaryRelationshipResponse = await httpRequest(url, request.body, params);
	const boundaryData = boundaryRelationshipResponse?.TenantBoundary?.[0]?.boundary;
	const allCodes = extractCodesFromBoundaryRelationshipResponse(boundaryData);
	let flag = 1;
	for (const { key: boundaryCode, value: boundaryType } of updatedBoundaryMap) {
	if (!allCodes.has(boundaryCode)) {
	const boundary = {
	tenantId: request?.body?.ResourceDetails?.tenantId,
	boundaryType: boundaryType,
	code: boundaryCode,
	hierarchyType: request?.body?.ResourceDetails?.hierarchyType,
	parent: modifiedChildParentMap.get(boundaryCode) ? modifiedChildParentMap.get(boundaryCode) : null
	};
	flag = 0;
	requestBody.BoundaryRelationship = boundary;
	// Introducing a delay of 1 second
	await new Promise(resolve => setTimeout(resolve, 1000));
	try {
	const response = await httpRequest(`${config.host.boundaryHost}${config.paths.boundaryRelationshipCreate}`, requestBody, {}, 'POST', undefined, undefined, true);
	if (!response.TenantBoundary || !Array.isArray(response.TenantBoundary) || response.TenantBoundary.length === 0) {
	throwError("BOUNDARY", 500, "BOUNDARY_RELATIONSHIP_CREATE_ERROR");
	}
	logger.info(`Boundary relationship created for boundaryType :: ${boundaryType} & boundaryCode :: ${boundaryCode} `);
	const newRequestBody = JSON.parse(JSON.stringify(request.body));
	activityMessage.push(await generateActivityMessage(request?.body?.ResourceDetails?.tenantId, request.body, newRequestBody, response, request?.body?.ResourceDetails?.type, url, response?.statusCode));
	} catch (error) {
	// Log the error and rethrow to be caught by the outer try...catch block
	logger.error(`Error creating boundary relationship for boundaryType :: ${boundaryType} & boundaryCode :: ${boundaryCode} :: `, error);
	throw error;
	}
	}
	};
	if (flag === 1) {
	throwError("COMMON", 400, "VALIDATION_ERROR", "Boundary already present in the system");
	}
	request.body = {
	...request.body,
	Activities: activityMessage
	};
	} catch (error: any) {
	const errorCode = error.code || "INTERNAL_SERVER_ERROR";
	const errorMessage = error.description || "Error while boundary relationship create";
	logger.error(`Error in createBoundaryRelationship: ${errorMessage}`, error);
	throwError("COMMON", 500, "BOUNDARY_RELATIONSHIP_CREATION_FAILED", "Failed to create boundary relationship due to: " + errorMessage);
	}

[coderabbitai]

Tip

Codebase Verification

The httpRequest function is implemented in utilities/project-factory/src/server/utils/request.ts. It includes error handling by catching exceptions and throwing errors with detailed messages. This indicates that httpRequest is capable of handling errors that occur during the HTTP request.

However, there is no explicit response validation in the callMdmsData function or the getMDMSV1Data function. The response from httpRequest is directly returned without any checks to ensure it meets expected criteria.

To ensure robust error handling and response validation, consider adding explicit checks in callMdmsData or getMDMSV1Data to validate the response structure and content before returning it.

Recommendations:

• Add response validation in callMdmsData to ensure the response contains the expected data.
• Ensure getMDMSV1Data handles any potential errors or unexpected response formats from callMdmsData.

Locations to address:

• utilities/project-factory/src/server/api/genericApis.ts (lines 995-1021 for callMdmsData and lines 1023-1026 for getMDMSV1Data)

Analysis chain

Validate the response handling in getMDMSV1Data.

This function wraps a call to another function and returns its result directly. Ensure that the called function (callMdmsData) properly handles all possible errors and that the response is correctly formatted and validated before being used.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify error handling in `callMdmsData` function.
ast-grep --lang typescript --pattern $'function callMdmsData($_, $_, $_, $_) {
  $$$
}'

Length of output: 2398

---

---

Script:

#!/bin/bash
# Search for the implementation of `httpRequest` function.
ast-grep --lang typescript --pattern $'function httpRequest($_, $_, $_) {
  $$$
}'

# Search for any additional error handling or response validation in `callMdmsData`.
rg 'callMdmsData' --context 10

# Search for the `getMDMSV1Data` function implementation.
ast-grep --lang typescript --pattern $'function getMDMSV1Data($_, $_, $_, $_) {
  $$$
}'

Length of output: 21429

---

---

Script:

#!/bin/bash
# Search for the implementation of `httpRequest` function.
rg 'httpRequest' --context 10

Length of output: 127407