Merge pull request #23 from ravilushqa/revert-21-revert-18-refactor

Revert 21 revert 18 refactor

Author: ravilushqa

.github/workflows/golangci-lint.yml

@@ -0,0 +1,46 @@
+name: golangci-lint
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - master
+      - main
+  pull_request:
+permissions:
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  # pull-requests: read
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          version: v1.52
+
+          # Optional: working directory, useful for monorepos
+          # working-directory: somedir
+
+          # Optional: golangci-lint command line arguments.
+          # args: --issues-exit-code=0
+
+          # Optional: show only new issues if it's a pull request. The default value is `false`.
+          # only-new-issues: true
+
+          # Optional: if set to true then the all caching functionality will be complete disabled,
+          #           takes precedence over all other caching options.
+          # skip-cache: true
+
+          # Optional: if set to true then the action don't cache or restore ~/go/pkg.
+          # skip-pkg-cache: true
+
+          # Optional: if set to true then the action don't cache or restore ~/.cache/go-build.
+          # skip-build-cache: true

.github/workflows/gpt_pullrequest_updater.yml

@@ -25,12 +25,11 @@ jobs:
       - name: Build description and review commands
         run: |
           cd gpt-pullrequest-updater
-          go build -o description ./cmd/description
-          go build -o review ./cmd/review
+          make build
 
       - name: Update Pull Request Description
         run: |
-          ./gpt-pullrequest-updater/description
+          ./gpt-pullrequest-updater/bin/description
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           OPENAI_TOKEN: ${{ secrets.OPENAI_TOKEN }}
@@ -41,7 +40,7 @@ jobs:
       - name: Review Pull Request
         if: github.event.action == 'opened'
         run: |
-          ./gpt-pullrequest-updater/review
+          ./gpt-pullrequest-updater/bin/review
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           OPENAI_TOKEN: ${{ secrets.OPENAI_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+bin
+.idea

.golangci.yaml

@@ -0,0 +1,41 @@
+# See https://golangci-lint.run/usage/configuration
+linters:
+  # Disable everything by default so upgrades to not include new "default
+  # enabled" linters.
+  disable-all: true
+  # Specifically enable linters we want to use.
+  enable:
+    - depguard
+    - errcheck
+    - godot
+    - gofmt
+    - goimports
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - revive
+    - staticcheck
+    - typecheck
+    - unused
+
+issues:
+  exclude-rules:
+    # helpers in tests often (rightfully) pass a *testing.T as their first argument
+    - path: _test\.go
+      text: "context.Context should be the first parameter of a function"
+      linters:
+        - golint
+    # Yes, they are, but it's okay in a test
+    - path: _test\.go
+      text: "exported func.*returns unexported type.*which can be annoying to use"
+      linters:
+        - golint
+
+linters-settings:
+  misspell:
+    locale: US
+    ignore-words:
+      - cancelled
+  goimports:
+    local-prefixes: github.com/ravilushqa/gpt-pullrequest-updater

Makefile

@@ -0,0 +1,45 @@
+.PHONY: init-tools lint test test-coverage precommit help
+
+build:
+	go build -o bin/description ./cmd/description && \
+	go build -o bin/review      ./cmd/review
+
+# run this once to install tools required for development.
+init-tools:
+	cd tools && \
+	go mod tidy && \
+	go mod verify && \
+	go generate -x -tags "tools"
+
+# run golangci-lint
+lint: init-tools
+	./bin/golangci-lint run --timeout=30m ./...
+
+# run go test
+test:
+	go test -race -count 1 ./...
+
+# run go test with coverage
+test-coverage:
+	go test -race -coverprofile=coverage.txt -covermode=atomic ./...
+
+# precommit command. run lint, test
+precommit: lint test
+
+# show help
+help:
+	@echo 'Usage:'
+	@echo ' make [target]'
+	@echo ''
+	@echo 'Targets:'
+	@awk '/^[a-zA-Z\-\_0-9]+:/ { \
+	helpMessage = match(lastLine, /^# (.*)/); \
+		if (helpMessage) { \
+			helpCommand = substr($$1, 0, index($$1, ":")-1); \
+			helpMessage = substr(lastLine, RSTART + 2, RLENGTH); \
+			printf "\033[36m%-22s\033[0m %s\n", helpCommand,helpMessage; \
+		} \
+	} \
+	{ lastLine = $$0 }' $(MAKEFILE_LIST)
+
+.DEFAULT_GOAL := help

README.md

@@ -101,12 +101,11 @@ jobs:
          - name: Build description and review commands
            run: |
               cd gpt-pullrequest-updater
-              go build -o description ./cmd/description
-              go build -o review ./cmd/review
+              make build
 
          - name: Update Pull Request Description
            run: |
-              ./gpt-pullrequest-updater/description
+              ./gpt-pullrequest-updater/bin/description
            env:
               GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
               OPENAI_TOKEN: ${{ secrets.OPENAI_TOKEN }}
@@ -117,7 +116,7 @@ jobs:
          - name: Review Pull Request
            if: github.event.action == 'opened'
            run: |
-              ./gpt-pullrequest-updater/review
+              ./gpt-pullrequest-updater/bin/review
            env:
               GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
               OPENAI_TOKEN: ${{ secrets.OPENAI_TOKEN }}

cmd/review/config.go

@@ -11,8 +11,18 @@ import (
 
 	ghClient "github.com/ravilushqa/gpt-pullrequest-updater/github"
 	oAIClient "github.com/ravilushqa/gpt-pullrequest-updater/openai"
+	"github.com/ravilushqa/gpt-pullrequest-updater/review"
 )
 
+var opts struct {
+	GithubToken string `long:"gh-token" env:"GITHUB_TOKEN" description:"GitHub token" required:"true"`
+	OpenAIToken string `long:"openai-token" env:"OPENAI_TOKEN" description:"OpenAI token" required:"true"`
+	Owner       string `long:"owner" env:"OWNER" description:"GitHub owner" required:"true"`
+	Repo        string `long:"repo" env:"REPO" description:"GitHub repo" required:"true"`
+	PRNumber    int    `long:"pr-number" env:"PR_NUMBER" description:"Pull request number" required:"true"`
+	Test        bool   `long:"test" env:"TEST" description:"Test mode"`
+}
+
 func main() {
 	ctx, cancel := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
 	defer cancel()
@@ -43,16 +53,17 @@ func run(ctx context.Context) error {
 		return fmt.Errorf("error getting commits: %w", err)
 	}
 
-	comments, err := processFiles(ctx, openAIClient, diff)
+	comments, err := review.GenerateCommentsFromDiff(ctx, openAIClient, diff)
 	if err != nil {
 		return err
 	}
 
 	if opts.Test {
 		fmt.Printf("Comments: %v \n", comments)
+		return nil
 	}
 
-	err = createComments(ctx, githubClient, comments)
+	err = review.PushComments(ctx, githubClient, opts.Owner, opts.Repo, opts.PRNumber, comments)
 	if err != nil {
 		return fmt.Errorf("error creating comments: %w", err)
 	}

cmd/review/main.go

@@ -6,17 +6,22 @@ require (
 	github.com/google/go-github/v51 v51.0.0
 	github.com/jessevdk/go-flags v1.5.0
 	github.com/sashabaranov/go-openai v1.7.0
+	github.com/stretchr/testify v1.8.2
 	golang.org/x/oauth2 v0.6.0
 )
 
 require (
 	github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8 // indirect
 	github.com/cloudflare/circl v1.1.0 // indirect
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/stretchr/objx v0.5.0 // indirect
 	golang.org/x/crypto v0.7.0 // indirect
 	golang.org/x/net v0.8.0 // indirect
 	golang.org/x/sys v0.6.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/protobuf v1.28.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.mod

@@ -3,6 +3,9 @@ github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8/go.mod h1:I0g
 github.com/bwesterb/go-ristretto v1.2.0/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0=
 github.com/cloudflare/circl v1.1.0 h1:bZgT/A+cikZnKIwn7xL2OBj012Bmvho/o6RpRvv3GKY=
 github.com/cloudflare/circl v1.1.0/go.mod h1:prBCrKB9DV4poKZY1l9zBXg2QJY7mvgRvtMxxK7fi4I=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/golang/protobuf v1.3.1/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk=
 github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw=
@@ -16,8 +19,18 @@ github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
 github.com/jessevdk/go-flags v1.5.0 h1:1jKYvbxEjfUl0fmqTCOfonvskHHXMjBySTLW4y9LFvc=
 github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/sashabaranov/go-openai v1.7.0 h1:D1dBXoZhtf/aKNu6WFf0c7Ah2NM30PZ/3Mqly6cZ7fk=
 github.com/sashabaranov/go-openai v1.7.0/go.mod h1:lj5b/K+zjTSFxVLijLSTDZuP7adOgerWeFyZLUhAKRg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c=
+github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
 golang.org/x/crypto v0.7.0 h1:AvwMYaRytfdeVt3u6mLaxYtErKYjxA2OXjJ1HHq6t3A=
@@ -47,3 +60,8 @@ google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp0
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
 google.golang.org/protobuf v1.28.0 h1:w43yiav+6bVFTBQFZX0r7ipe9JQ1QsbMgHwbBziscLw=
 google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

go.sum

@@ -5,7 +5,7 @@ import (
 	"regexp"
 )
 
-const ticketUrlFormat = "%s/browse/%s"
+const ticketURLFormat = "%s/browse/%s"
 
 // ExtractJiraTicketID returns the first JIRA ticket ID found in the input string.
 func ExtractJiraTicketID(s string) (string, error) {
@@ -25,5 +25,5 @@ func ExtractJiraTicketID(s string) (string, error) {
 }
 
 func GenerateJiraTicketURL(jiraURL, ticketID string) string {
-	return fmt.Sprintf(ticketUrlFormat, jiraURL, ticketID)
+	return fmt.Sprintf(ticketURLFormat, jiraURL, ticketID)
 }

jira/jira.go

@@ -4,11 +4,12 @@ import (
 	"context"
 	_ "embed"
 	"fmt"
+	"time"
 
 	"github.com/sashabaranov/go-openai"
 )
 
-//go:embed prompt-review.txt
+//go:embed prompts/review
 var PromptReview string
 
 const (
@@ -37,8 +38,21 @@ func (o *Client) ChatCompletion(ctx context.Context, messages []openai.ChatCompl
 	)
 
 	if err != nil {
-		fmt.Printf("ChatCompletion error: %v\n", err)
-		return "", err
+		fmt.Println("Error completing prompt:", err)
+		fmt.Println("Retrying after 1 minute")
+		// retry once after 1 minute
+		time.Sleep(time.Minute)
+		resp, err = o.client.CreateChatCompletion(
+			ctx,
+			openai.ChatCompletionRequest{
+				Model:       openai.GPT3Dot5Turbo,
+				Messages:    messages,
+				Temperature: 0.1,
+			},
+		)
+		if err != nil {
+			return "", fmt.Errorf("error completing prompt: %w", err)
+		}
 	}
 
 	return resp.Choices[0].Message.Content, nil