fix: array index mapping error handling

[koladilip]

What are the changes introduced in this PR?

There was an unhandled error scenario so code is throwing TypeError and now added check to throw correct error.

What is the related Linear task?

Resolves INT-2240

Please explain the objectives of your changes below

Put down any required details on the broader aspect of your changes. If there are any dependent changes, mandatorily mention them here

Any changes to existing capabilities/behaviour, mention the reason & what are the changes ?

N/A

Any new dependencies introduced with this change?

N/A

Any new generic utility introduced or modified. Please explain the changes.

N/A

Any technical or performance related pointers to consider with the change?

N/A

@coderabbitai review

---

Developer checklist

• My code follows the style guidelines of this project

• No breaking changes are being introduced.

• All related docs linked with the PR?

• All changes manually tested?

• Any documentation changes needed with this change?

• Is the PR limited to 10 file changes?

• Is the PR limited to one linear task?

• Are relevant unit and component test-cases added?

Reviewer checklist

• Is the type of change in the PR title appropriate as per the changes?

• Verified that there are no credentials or confidential data exposed with the changes.

Summary by CodeRabbit

• New Features

  • Support for dynamic key-value pairs in FlatMappingPaths type.

• Bug Fixes

  • Added type check and error handling for invalid array index mapping.

• Tests

  • Added a new test scenario for invalid array index mappings.

• Chores

  • Updated Codecov action to use actions/checkout@v4 for better stability and performance.

[coderabbitai]

Walkthrough

This update introduces several enhancements and fixes to the codebase. Key improvements include adding dynamic key-value pairs to the FlatMappingPaths type, enhancing the robustness of the processArrayIndexFilter function with additional type checks and error handling, and incorporating new test scenarios for invalid array index mappings. Additionally, the CI pipeline has been updated to use a newer version of the actions/checkout action.

Changes

Files	Change Summary
src/types.ts	Added dynamic key-value pairs to the FlatMappingPaths type.
src/utils/converter.ts	Enhanced processArrayIndexFilter function with type checks and error handling.
test/scenarios/mappings/data.ts	Introduced a new test scenario for invalid array index mappings.
test/scenarios/...index_mappings.json	Added mappings file to test invalid array index transformations.
.github/workflows/codecov.yml	Updated actions/checkout action version from v1 to v4 in the CI configuration.

Poem

In the lines of code, with care we tread,
A mapping path now can be widespread.
Errors caught with checks anew,
Indices mapped, tests to view.
CI flows with updated might,
Our code evolves, a coder's delight.
🌟🐇💻

---

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.

[github-actions]

Coverage report

St.❔	Category	Percentage	Covered / Total
🟢	Statements	91.44% (-8.56% 🔻)	4563/4990
🟢	Branches	89.23% (-10.77% 🔻)	1077/1207
🟢	Functions	100%	372/372
🟢	Lines	91.44% (-8.56% 🔻)	4563/4990

Show files with reduced coverage 🔻

St.❔	File	Statements	Branches	Functions	Lines
🟢	engine.ts	97.62% (-2.38% 🔻)	89.19% (-10.81% 🔻)	100%	97.62% (-2.38% 🔻)
🟢	lexer.ts	86.15% (-13.85% 🔻)	90.65% (-9.35% 🔻)	100%	86.15% (-13.85% 🔻)
🟢	parser.ts	86.32% (-13.68% 🔻)	86.78% (-13.22% 🔻)	100%	86.32% (-13.68% 🔻)
🟢	reverse_translator.ts	89.75% (-10.25% 🔻)	81.89% (-18.11% 🔻)	100%	89.75% (-10.25% 🔻)
🟢	utils/common.ts	100%	88.89% (-11.11% 🔻)	100%	100%
🟢	utils/converter.ts	88.73% (-11.27% 🔻)	80.91% (-19.09% 🔻)	100%	88.73% (-11.27% 🔻)

Test suite run success

211 tests passing in 6 suites.

Report generated by 🧪jest coverage report action from a7952d5

[codecov]

Codecov Report

Attention: Patch coverage is 40.00000% with 6 lines in your changes missing coverage. Please review.

Project coverage is 91.44%. Comparing base (97d95e8) to head (a7952d5).
Report is 46 commits behind head on main.

Files	Patch %	Lines
src/utils/converter.ts	33.33%	6 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##              main     #115      +/-   ##
===========================================
- Coverage   100.00%   91.44%   -8.56%     
===========================================
  Files           14       18       +4     
  Lines         4565     4990     +425     
  Branches      1082     1090       +8     
===========================================
- Hits          4565     4563       -2     
- Misses           0      418     +418     
- Partials         0        9       +9     

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

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0d09b0b and c6f0f3d.

Files selected for processing (4)

• src/types.ts (1 hunks)
• src/utils/converter.ts (1 hunks)
• test/scenarios/mappings/data.ts (1 hunks)
• test/scenarios/mappings/invalid_array_index_mappings.json (1 hunks)

Files skipped from review due to trivial changes (1)

• test/scenarios/mappings/invalid_array_index_mappings.json

Additional context used

GitHub Check: codecov/patch

src/utils/converter.ts

[warning] 63-68: src/utils/converter.ts#L63-L68
Added lines #L63 - L68 were not covered by tests

GitHub Check: Coverage annotations (🧪 jest-coverage-report-action)

src/utils/converter.ts

[warning] 63-63: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 64-64: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 65-65: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 66-66: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 67-67: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 68-68: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 62-68: 🌿 Branch is not covered
Warning! Not covered branch

Additional comments not posted (3)

src/types.ts (1)

285-285: LGTM!

The addition of [key: string]: any; in the FlatMappingPaths type allows for dynamic key-value pairs, enhancing flexibility.

test/scenarios/mappings/data.ts (1)

190-193: LGTM!

The new test scenario for invalid array index mappings is well-aligned with the PR's objective of handling array index mapping errors.

src/utils/converter.ts (1)

62-68: LGTM!

The added type check and error handling ensure that invalid array index mappings are correctly handled by throwing a JsonTemplateMappingError.

Tools

GitHub Check: codecov/patch

[warning] 63-68: src/utils/converter.ts#L63-L68
Added lines #L63 - L68 were not covered by tests

GitHub Check: Coverage annotations (🧪 jest-coverage-report-action)

[warning] 63-63: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 64-64: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 65-65: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 66-66: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 67-67: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 68-68: 🧾 Statement is not covered
Warning! Not covered statement

---

[warning] 62-68: 🌿 Branch is not covered
Warning! Not covered branch

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
89.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c6f0f3d and a7952d5.

Files selected for processing (1)

• .github/workflows/codecov.yml (1 hunks)

Files skipped from review due to trivial changes (1)

• .github/workflows/codecov.yml