[Good First Issues]: implement function "replace_string" - 8 points

[JieDing]

Motivation

Vanus Functions are a series of pre-built functions worked within Vanus transformer. By choosing a function, users can specify the way that events will be changed.

It will be a good start if you decide to contribute to Vanus codes.

Details

This function is used to replace a sub-string of an existed json element with a specific new string.

Description

Function name: replace_string

Function args:

• path: the json path of the string which needs to be replaced.
• subValue: the sub-string you'd like to replace.
• targetValue: the string used to replace the old one.

Function description: Replace a sub-string of an existed json element with a specific new string. The previous value of the json object will be replaced.

Example

For example, if users' original event looks like this:

{
    "specversion" : "1.0",
    "type" : "com.example.someevent",
    "source" : "/mycontext",
    "subject": null,
    "id" : "C234-1234-1234",
    "time" : "2018-04-05T17:31:00Z",
    "comexampleextension1" : "value",
    "comexampleothervalue" : 5,
    "datacontenttype" : "application/json",
    "data" : {
        "appinfoA" : "this is jay ding",
        "appinfoB" : 123,
        "appinfoC" : true
    }
}

After the function "replace_string":

"pipeline":[
    {"command":["replace_string","$.data.appinfoA","jay","Michael"]}
]

The transformed event should look like:

{
    "specversion" : "1.0",
    "type" : "com.example.someevent",
    "source" : "/mycontext",
    "subject": null,
    "id" : "C234-1234-1234",
    "time" : "2018-04-05T17:31:00Z",
    "comexampleextension1" : "value",
    "comexampleothervalue" : 5,
    "datacontenttype" : "application/json",
    "data" : {
        "appinfoA" : "This is Michael ding",
        "appinfoB" : 123,
        "appinfoC" : true
    }
}

How to implement

1. Fork the vanus repository.
2. Create a branch function-replace-string
3. Create replace_string.go under internal/primitive/transform/action/strings, and then implement the function.
4. Create replace_string_test.go under internal/primitive/transform/action/strings for unit test.
5. Register your function in internal/primitive/transform/runtime/init.go.
6. Submit your PR

Contribution points

Each issue counts specific points based on its difficulty. Contributors earn the corresponding points if they solve that issue. Contribution points are used to describe the contributions contributors have made. They can also be used to get rewards when there are community events.

This issue counts 8 points.

How to claim to solve the issue

If you want to implement this function, please leave a comment in this issue like:

I'd like to implement this function, please assign this issue to me.

Vanus community will assign the issue to you on time.

[stavrmaria]

Hi I would like to implement this function, please assign it to me. I have to say I am a beginner I really want to contribute to this project.

[VedaGao]

@stavrmaria Hi, thanks for your comment. I will assign it to you. I hope you're off to a good start.

[JieDing]

Hi I would like to implement this function, please assign it to me. I have to say I am a beginner I really want to contribute to this project.

Hi @stavrmaria , how is it going with this function? You may have some questions during implementation, Join the Slack channel to discuss with other developers. Also there you can know details about how to get contribution rewards.