refactor: engine and add more utilites

[koladilip]

What are the changes introduced in this PR?

add more utilites

What is the related Linear task?

Resolves INT-2277

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

• Documentation

  • Updated README with a duplicated "Getting started" section.

• Refactor

  • Simplified scenario evaluation in tests by eliminating redundant template engine creation.
  • Renamed and updated functions to improve clarity and handle mappings in JsonTemplateEngine.

• New Features

  • Introduced a new data module exporting Scenario objects for test scenarios.

[coderabbitai]

Warning

Review failed

The pull request is closed.

Walkthrough

The updates encompass various enhancements and refactorings across multiple files. Key changes include the duplication of the "Getting started" section in the readme.md, modifications to the JsonTemplateEngine class in src/engine.ts, and updates to the TemplateInput type in src/types.ts. Additionally, several test files have been streamlined by removing redundant template engine creation steps, and a new data module for scenarios has been introduced.

Changes

Files	Change Summary
readme.md	Duplicated the "Getting started" section, resulting in redundant information.
src/engine.ts	Updated JsonTemplateEngine class with new imports, method signature changes, added checks, and new static methods.
src/types.ts	Modified TemplateInput type to include undefined.
test/e2e.test.ts, test/scenario.test.ts	Removed creation of template engine before scenario evaluation, simplifying the code.
test/scenarios/base/data.ts	Introduced a new module exporting an array of Scenario objects.
test/utils/scenario.ts	Refactored initializeScenario function, renamed createTemplateEngine to evaluateScenario, and added logic to handle scenarios with mappings using JsonTemplateEngine. Added new getTemplate function for retrieving templates.

Poem

In the code's vast land, changes bloom,
Engines refined, tests resume.
Templates now with undefined grace,
Scenarios run at a simpler pace.
Data modules join the race,
In this update's warm embrace. 🌸

---

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	100%	4554/4554
🟢	Branches	100%	1218/1218
🟢	Functions	100%	341/341
🟢	Lines	100%	4554/4554

Test suite run success

167 tests passing in 4 suites.

Report generated by 🧪jest coverage report action from 20635f4

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (63b15d8) to head (20635f4).
Report is 19 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #73   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           14        14           
  Lines         4549      4554    +5     
  Branches      1076      1073    -3     
=========================================
+ Hits          4549      4554    +5     

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

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud