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

chore: parse json using custom separators #5037

Closed
wants to merge 3 commits into from

Conversation

Sidddddarth
Copy link
Member

@Sidddddarth Sidddddarth commented Aug 28, 2024

Description

A custom method(scaffolding) to parse json response from transformer.

Some associated benchmarks:

Existing transformer response unmarshal

=== RUN   BenchmarkUnmarshalTransformerResponse
BenchmarkUnmarshalTransformerResponse
BenchmarkUnmarshalTransformerResponse-10           18355             64911 ns/op           54091 B/op       1253 allocs/op
PASS
ok      github.com/rudderlabs/rudder-server/processor/transformer       2.293s

If Output in TransformerResponse was json.RawMessage

=== RUN   BenchmarkUnmarshalTransformerResponse2
BenchmarkUnmarshalTransformerResponse2
BenchmarkUnmarshalTransformerResponse2-10          39862             29601 ns/op           23613 B/op        464 allocs/op
PASS
ok      github.com/rudderlabs/rudder-server/processor/transformer       2.089s

Unmarshal using jsoniter.ConfigFastest

BenchmarkFastestUnmarshal-10    	   19616	     60979 ns/op	   51469 B/op	    1113 allocs/op
PASS
ok  	github.com/rudderlabs/rudder-server/processor/transformer	2.262s

Using jsoniter.ConfigFastest with json.RawMessage Output

=== RUN   BenchmarkFastestUnmarshalTransformerResponse2
BenchmarkFastestUnmarshalTransformerResponse2
BenchmarkFastestUnmarshalTransformerResponse2-10           43570             27036 ns/op           21501 B/op        324 allocs/op
PASS
ok      github.com/rudderlabs/rudder-server/processor/transformer       1.960s

Using byte array separators

BenchmarkParseNewResponse/parseNewResponse-10             233391              4570 ns/op             876 B/op         12 allocs/op
PASS
ok      github.com/rudderlabs/rudder-server/processor/transformer       1.569s

Although this last result looks great, we can't be sure at this point as to how it affects transformer(both runtime and the estimate about the labour required). Even within rudder-server, it'll need a decent refactor around different areas in processor - although they can be picked up irrespective of this "change", things like minimising changing event payload from map[string]interface{} to []byte and back again several times - adding some fields to/parsing(gjson etc.) the payload.

Linear Ticket

Resolves PIPE-1487

Security

  • The code changed/added as part of this pull request won't create any security issues with how the software is being used.

In hindsight this looks silly, can be done differently - using ordering of things instead of using delimiter literals.
Simple . separated json with things of interest (base64 etc.) encoded.
Can provide a hierarchical relationship if required.

Copy link
Contributor

coderabbitai bot commented Aug 28, 2024

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

codecov bot commented Sep 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.55%. Comparing base (e832eae) to head (fae92e4).
Report is 5 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5037      +/-   ##
==========================================
- Coverage   74.70%   74.55%   -0.15%     
==========================================
  Files         430      436       +6     
  Lines       50131    50385     +254     
==========================================
+ Hits        37450    37567     +117     
- Misses      10202    10321     +119     
- Partials     2479     2497      +18     

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

Copy link

This PR is considered to be stale. It has been open 20 days with no further activity thus it is going to be closed in 7 days. To avoid such a case please consider removing the stale label manually or add a comment to the PR.

@github-actions github-actions bot added the Stale label Sep 25, 2024
@github-actions github-actions bot closed this Oct 3, 2024
@github-actions github-actions bot deleted the chore.customJSONParsing branch November 4, 2024 02:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant