Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: standard function names in generating code #66

Merged
merged 6 commits into from
Jun 7, 2024

Conversation

koladilip
Copy link
Collaborator

@koladilip koladilip commented Jun 7, 2024

What are the changes introduced in this PR?

if we use standard function names as variables names then it is failing so adding prefix ___ while generating code for standard functions code

What is the related Linear task?

Resolves INT-2160

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

  • Refactor

    • Prefixed function names with a variable for better flexibility and consistency.
    • Updated function calls in templates to use the new prefixed names.
  • Bug Fixes

    • Fixed an issue with function calls in JSON template translations to include the necessary prefix for consistency.

These changes ensure better maintainability and consistency across the codebase.

@koladilip koladilip requested a review from a team as a code owner June 7, 2024 08:13
@koladilip koladilip requested review from sanpj2292 and chandumlg June 7, 2024 08:13
Copy link

coderabbitai bot commented Jun 7, 2024

Walkthrough

The changes introduce a prefix (VARS_PREFIX) to function names within standardFunctions in src/operators.ts. This adjustment ensures that all function names are standardized with the prefix. Additionally, the JsonTemplateTranslator class in src/translator.ts is updated to reflect this prefix in its function calls. Test scenarios in template.jt are also simplified to directly reference object keys.

Changes

File Path Change Summary
src/operators.ts Added VARS_PREFIX to function names within standardFunctions object.
src/translator.ts Updated JsonTemplateTranslator class to prepend VARS_PREFIX to function calls in an assignment statement.
test/scenarios/standard_functions/template.jt Simplified code by directly referencing object keys without calling the keys() method.

Poem

In code's vast fields where functions play,
Prefixes now lead the way.
With VARS_PREFIX they proudly stand,
Bringing order to this land.
Translators speak with newfound grace,
Keys unlocked, a simpler place.
In harmony, the changes blend,
A coder's joy, without end.


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

Copy link
Contributor

github-actions bot commented Jun 7, 2024

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements 100% 4565/4565
🟢 Branches 100% 1223/1223
🟢 Functions 100% 343/343
🟢 Lines 100% 4565/4565

Test suite run success

166 tests passing in 4 suites.

Report generated by 🧪jest coverage report action from 9cd5c72

Copy link

sonarqubecloud bot commented Jun 7, 2024

Copy link

codecov bot commented Jun 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (19d94c2) to head (9cd5c72).
Report is 52 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##              main       #66     +/-   ##
===========================================
  Coverage   100.00%   100.00%             
===========================================
  Files           10        14      +4     
  Lines         3078      4565   +1487     
  Branches       726      1079    +353     
===========================================
+ Hits          3078      4565   +1487     

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 08852cf and 9cd5c72.

Files selected for processing (3)
  • src/operators.ts (3 hunks)
  • src/translator.ts (1 hunks)
  • test/scenarios/standard_functions/template.jt (2 hunks)
Additional comments not posted (3)
test/scenarios/standard_functions/template.jt (1)

3-3: Verify the usage of keys to ensure it aligns with the new implementation.

src/operators.ts (1)

Line range hint 123-182: Ensure all calls to standard functions use the new prefixed names.

Verification successful

The verification process confirms that all calls to the standard functions use the new prefixed names consistently throughout the codebase.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify all calls to standard functions use the new prefixed names.

# Test: Search for the usage of standard functions without the prefix. Expect: No occurrences without the prefix.
rg --type js 'function (sum|max|min|avg|length|stddev|first|last|index|keys)\('

Length of output: 81



Script:

#!/bin/bash
# Description: Verify all calls to standard functions use the new prefixed names.

# Test: Search for the usage of standard functions without the prefix in various contexts.
# Expect: No occurrences without the prefix.

# Search for function calls
rg --type js '\b(sum|max|min|avg|length|stddev|first|last|index|keys)\('

# Search for variable assignments
rg --type js '\b(sum|max|min|avg|length|stddev|first|last|index|keys)\s*='

# Search for object properties
rg --type js '\b(sum|max|min|avg|length|stddev|first|last|index|keys)\s*:'

Length of output: 228

src/translator.ts (1)

522-532: Ensure the new function call format with VARS_PREFIX is correctly implemented across all relevant parts of the codebase.

@koladilip koladilip merged commit 79269f3 into main Jun 7, 2024
25 checks passed
@koladilip koladilip deleted the fix.standard-functions-logic branch June 7, 2024 08:22
@github-actions github-actions bot mentioned this pull request Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants