Initial Jira connector commit #3613

zoltancsontosness · 2025-09-16T04:12:18Z

Redpanda Jira Connector

Connector	Path
Jira	connect/public/components/jira

Prerequisites for development

Install go
Install go-task

go install github.com/go-task/task/v3/cmd/task@latest

Running & testing the connector

Set GOBIN variable

go env -w GOBIN=$(pwd)/bin
Lint and format the code
```
task lint
task fmt
```
Build the application

go build
Set variables specific to connector that you are running based on config.yaml file (see redpanda secrets):

export JIRA_API_TOKEN=yourToken
Run the connector

./connect --config config.yaml

Config & usage examples

Example processor configuration:

pipeline:
  threads: 1
  processors:
    - jira:
        base_url: "https://{your_org}.atlassian.net"
        username: "jiraUsername"
        api_token: "${JIRA_API_TOKEN}"
        max_results_per_page: 200
        max_retries: 50

Example input configuration that produces one message into the pipeline:

input:
  generate:
    interval: "1m"
    count: 1 # 0 for infinite @ specified interval
    mapping: |
      root = {
        "project": "RPC",
        "fields": ["summary", "Story Points", "assignee.displayName", "Sprint.name"],
        "updated": ">= -4w",
        "created": ">= -4w"
      }

Example message using JQL query - this retrieves the summary, name of sprint and story points for an issue from an user that is having status In progress

{
    "fields": ["summary", "Sprint.name", "Story Points"],
    "jql": "assignee=\"Andrei Arcan\" and status=\"In Progress\" order by created DESC"
}

Example message using Project - this gets the summary and status for all issues that are created in the last 4 weeks and updated in the last 2 days for RPC project

{
    "project": "RPC",
    "fields": ["summary", "status.name"],
    "created": ">= -4w",
    "updated": ">= -2d"
}

Example message using Project - this gets all fields for all issues

{
    "project": "RPC"
}

Jeffail

Hey @zoltancsontosness! Just a couple of comments, code looks really neat on a first pass through.

Jeffail · 2025-09-16T08:25:50Z

internal/impl/jira/logging.go

+args: optional arguments for format string interpolation
+*/
+func (j *jiraProc) debug(format string, args ...interface{}) {
+	if j != nil && j.log != nil {


It's actually safe to call methods on a nil *service.Logger as it already guards against nil references: https://github.com/redpanda-data/benthos/blob/main/public/service/logger.go#L49, so we don't really need this wrapper and are probably better off without it.

done ✔️

Jeffail · 2025-09-16T09:59:50Z

internal/impl/jira/constants.go

+package jira
+
+// JiraAPIBasePath is the base path for Jira Rest API
+const JiraAPIBasePath = "/rest/api/3"


This probably doesn't need to be its own file, lets move this into client.go.

done ✔️

mmatczuk · 2025-09-16T16:15:26Z

Would you mind converting block comments to line comments especially for docstrings?

mmatczuk · 2025-09-16T16:16:15Z

internal/impl/jira/README.md

@@ -0,0 +1 @@
+package jira


This is probably not needed.

done ✔️

mmatczuk · 2025-09-16T16:16:59Z

Also, would be good to add file headers.

mmatczuk · 2025-09-16T16:33:10Z

internal/impl/jira/config.go

+	"github.com/redpanda-data/benthos/v4/public/service"
+)
+
+type jiraProc struct {


I like the split to different resources files, I'm confused why this one is called config?

Probably jiraProc belongs to resources, the rest to processor.

done ✔️

mmatczuk · 2025-09-16T16:43:46Z

I’d like to suggest we reduce the number of exported types in the package to keep the API simple and easy to use. It would also be clearer if all Jira-specific code lived in a single package, for example jirahttp. In that case, I suggest we migrate all of the helpers content (and its subpackages) into jirahttp, so everything Jira-related is grouped in one place. Our internal Jira library can then live under the jira package.

mmatczuk · 2025-09-16T16:45:54Z

Please add enterprise license check

Look for

	if err := license.CheckRunningEnterprise(mgr); err != nil {
		return nil, err
	}

mmatczuk · 2025-09-16T16:48:20Z

internal/impl/jira/filter.go

+If customFields are present in the data, they will also be replaced with their real name;
+example: custom_field_10100 will be replaced with "Story Points"
+*/
+func (j *jiraProc) filter(data interface{}, selectors selectorTree, custom map[string]string) (interface{}, error) {


Use any instead of interface{}

Could this be a function not method? Or method of selectorTree?

done ✔️

mmatczuk · 2025-09-16T16:51:46Z

internal/impl/jira/filter.go

+	"summary": {}
+	}
+*/
+func (j *jiraProc) buildSelectorTree(fields []string, custom map[string]string) (selectorTree, error) {


How about selectorTreeFrom() - a constructor not a method of jiraProc

done ✔️

mmatczuk · 2025-09-16T16:54:34Z

internal/impl/jira/helpers/http_helper/http_helper.go

+Package http_helper usage
+
+Overview
+- Provides a thin, robust wrapper around net/http to:


Improve rendering in go doc.

done ✔️

mmatczuk · 2025-09-16T16:56:29Z

internal/impl/jira/helpers/jira_helper/jira_helper.go

+
+ 5. Example helper wrapping a Jira call
+
+    func callJira(ctx context.Context, client *http.Client, req *http.Request) ([]byte, *jira_helper.JiraError) {


Improve code formatting - maybe use examples https://go.dev/blog/examples

Fix/jira processor pr comments

CLAassistant · 2025-09-22T14:46:35Z

All committers have signed the CLA.

…rahttp package;

reduce number of exported types; moved most of the code inside the jirahttp package;

mmatczuk · 2025-10-03T14:30:23Z