Merge pull request #70 from eurofurence/issue-66-ef-2024

Issue 66 ef 2024

.github/workflows/docker.yml

@@ -4,9 +4,12 @@ on:
   push:
     branches:
       - 'main'
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
-  call_build-and-push-image:
+  call_build-and-push-image_latest:
+    if: startsWith(github.ref, 'refs/heads/')
     permissions:
       contents: read
       packages: write
@@ -20,3 +23,19 @@ jobs:
       registry-user: ${{ github.actor }}
     secrets:
       registry-pass: ${{ secrets.GITHUB_TOKEN }}
+
+  call_build-and-push-image_versioned:
+    if: startsWith(github.ref, 'refs/tags/v0.1.')
+    permissions:
+      contents: read
+      packages: write
+    uses: eurofurence/reg-workflows/.github/workflows/docker-build-push.yml@main
+    with:
+      image-name: ${{ github.repository }}
+      image-tags: ${{ github.ref_name }} v0.1
+      full-repo-url: https://github.com/${{ github.repository }}
+      branch-or-tag-name: ${{ github.ref_name }}
+      commit-hash: ${{ github.sha }}
+      registry-user: ${{ github.actor }}
+    secrets:
+      registry-pass: ${{ secrets.GITHUB_TOKEN }}

docs/config-template.yaml

@@ -16,6 +16,8 @@ service:
   # if set, will add these redirects to the request for the paylink
   success_redirect: 'http://localhost:10000/app/register'
   failure_redirect: 'http://localhost:10000/app/register'
+  # the service will reject webhooks that reference another prefix (previous year expiry, etc.)
+  transaction_id_prefix: "EF2023"
 server:
   port: 9097
 database:

internal/repository/concardis/mock.go

@@ -51,6 +51,27 @@ func newMock() Mock {
 			},
 		},
 	}
+	simData[4242] = PaymentLinkQueryResponse{
+		ID:          4242,
+		Status:      "confirmed",
+		ReferenceID: "230001-122218-000001",
+		Link:        constructSimulatedPaylink("4242"),
+		Name:        "Online-Shop payment #002",
+		Purpose:     map[string]string{"1": "some payment purpose"},
+		Amount:      390,
+		Currency:    "EUR",
+		CreatedAt:   1418392958,
+		Invoices: []PaymentLinkInvoice{
+			{
+				Transactions: []TransactionData{
+					{
+						Time: "2023-01-08 12:22:58",
+						UUID: "d3adb33f",
+					},
+				},
+			},
+		},
+	}
 	return &mockImpl{
 		recording:     make([]string, 0),
 		simulatorData: simData,

internal/repository/config/config.go

@@ -95,6 +95,10 @@ func WebhookSecret() string {
 	return Configuration().Security.Fixed.Webhook
 }
 
+func TransactionIDPrefix() string {
+	return Configuration().Service.TransactionIDPrefix
+}
+
 func InvoiceTitle() string {
 	return Configuration().Invoice.Title
 }

internal/repository/config/structure.go

@@ -41,6 +41,7 @@ type ServiceConfig struct {
 	ConcardisApiSecret  string `yaml:"concardis_api_secret"` // your instance's api secret, required
 	SuccessRedirect     string `yaml:"success_redirect"`
 	FailureRedirect     string `yaml:"failure_redirect"`
+	TransactionIDPrefix string `yaml:"transaction_id_prefix"`
 }
 
 // DatabaseConfig configures which db to use (mysql, inmemory)

internal/repository/paymentservice/interface.go

@@ -28,6 +28,7 @@ type PaymentMethod string
 
 const (
 	Credit   PaymentMethod = "credit"
+	Cash     PaymentMethod = "cash"
 	Paypal   PaymentMethod = "paypal"
 	Transfer PaymentMethod = "transfer"
 	Internal PaymentMethod = "internal"

internal/service/paymentlinksrv/webhook.go

@@ -5,7 +5,9 @@ import (
 	"errors"
 	"fmt"
 	"github.com/eurofurence/reg-payment-cncrd-adapter/internal/entity"
+	"github.com/eurofurence/reg-payment-cncrd-adapter/internal/repository/config"
 	"github.com/eurofurence/reg-payment-cncrd-adapter/internal/repository/database"
+	"github.com/eurofurence/reg-payment-cncrd-adapter/internal/web/util/ctxvalues"
 	"strconv"
 	"strings"
 	"time"
@@ -47,7 +49,7 @@ func (i *Impl) HandleWebhook(ctx context.Context, webhook cncrdapi.WebhookEventD
 			Kind:        "error",
 			Message:     "webhook query-pay-link failed",
 			Details:     err.Error(),
-			RequestId:   "",
+			RequestId:   ctxvalues.RequestId(ctx),
 		})
 		_ = i.SendErrorNotifyMail(ctx, "webhook", fmt.Sprintf("paylinkId: %d", paylinkId), "api-error")
 		return err
@@ -63,12 +65,29 @@ func (i *Impl) HandleWebhook(ctx context.Context, webhook cncrdapi.WebhookEventD
 			Kind:        "error",
 			Message:     "webhook ref-id-mismatch",
 			Details:     fmt.Sprintf("response ref-id=%s vs webhook ref-id=%s", paylink.ReferenceID, webhook.Transaction.Invoice.ReferenceId),
-			RequestId:   "",
+			RequestId:   ctxvalues.RequestId(ctx),
 		})
 		_ = i.SendErrorNotifyMail(ctx, "webhook", fmt.Sprintf("paylinkId: %d", paylinkId), "ref-id-mismatch")
 		return WebhookRefIdMismatchErr
 	}
 
+	prefix := config.TransactionIDPrefix()
+	if prefix != "" && !strings.HasPrefix(paylink.ReferenceID, prefix) {
+		aulogging.Logger.Ctx(ctx).Warn().Printf("webhook with wrong ref id prefix, ref_id=%s", paylink.ReferenceID)
+		db := database.GetRepository()
+		_ = db.WriteProtocolEntry(ctx, &entity.ProtocolEntry{
+			ReferenceId: webhook.Transaction.Invoice.ReferenceId,
+			ApiId:       paylinkId,
+			Kind:        "error",
+			Message:     "webhook ref-id-prefix",
+			Details:     fmt.Sprintf("ref-id=%s", paylink.ReferenceID),
+			RequestId:   ctxvalues.RequestId(ctx),
+		})
+		_ = i.SendErrorNotifyMail(ctx, "webhook", paylink.ReferenceID, "ref-id-prefix")
+		// report success so they don't retry, it's not a big problem after all
+		return nil
+	}
+
 	aulogging.Logger.Ctx(ctx).Info().Printf("webhook call for paylink id=%d ref=%s status=%s amount=%d", paylink.ID, paylink.ReferenceID, paylink.Status, paylink.Amount)
 	db := database.GetRepository()
 	_ = db.WriteProtocolEntry(ctx, &entity.ProtocolEntry{
@@ -77,7 +96,7 @@ func (i *Impl) HandleWebhook(ctx context.Context, webhook cncrdapi.WebhookEventD
 		Kind:        "success",
 		Message:     "webhook query-pay-link",
 		Details:     fmt.Sprintf("status=%s amount=%d", paylink.Status, paylink.Amount),
-		RequestId:   "",
+		RequestId:   ctxvalues.RequestId(ctx),
 	})
 
 	if paylink.Status == "cancelled" || paylink.Status == "declined" {

internal/web/app/logging.go

@@ -11,6 +11,7 @@ func setupLogging(applicationName string, useEcsLogging bool) {
 	aulogging.RequestIdRetriever = ctxvalues.RequestId
 	if useEcsLogging {
 		auzerolog.SetupJsonLogging(applicationName)
+		zerolog.TimeFieldFormat = "2006-01-02T15:04:05.000Z"
 	} else {
 		aulogging.DefaultRequestIdValue = "00000000"
 		auzerolog.SetupPlaintextLogging()

test/acceptance/webhook_acc_test.go

@@ -137,6 +137,66 @@ func TestWebhook_DownstreamError(t *testing.T) {
 	tstRequireErrorResponse(t, response, http.StatusBadGateway, "webhook.downstream.error", nil)
 }
 
+func TestWebhook_Success_Status_WrongPrefix(t *testing.T) {
+	tstSetup(tstConfigFile)
+	defer tstShutdown()
+
+	docs.Given("given the payment provider has a transaction in status confirmed")
+
+	docs.Given("and an anonymous caller who knows the secret url")
+	url := "/api/rest/v1/webhook/demosecret"
+
+	docs.When("when they trigger our webhook endpoint with the wrong prefix")
+	request := `
+{
+   "transaction": {
+       "id": 1892362736,
+       "invoice": {
+           "paymentRequestId": 4242,
+           "referenceId": "230001-122218-000001"
+       }
+   }
+}
+`
+	response := tstPerformPost(url, request, tstNoToken())
+
+	docs.Then("then the request is successful")
+	require.Equal(t, http.StatusOK, response.status)
+
+	docs.Then("and the expected downstream requests have been made to the concardis api")
+	tstRequireConcardisRecording(t,
+		"QueryPaymentLink 4242",
+	)
+
+	docs.Then("and no requests to the payment service have been made")
+	tstRequirePaymentServiceRecording(t, nil)
+
+	docs.Then("and the expected error notification emails have been sent")
+	tstRequireMailServiceRecording(t, []mailservice.MailSendDto{
+		{
+			CommonID: "payment-cncrd-adapter-error",
+			Lang:     "en-US",
+			To: []string{
+				"[email protected]",
+			},
+			Variables: map[string]string{
+				"status":      "ref-id-prefix",
+				"operation":   "webhook",
+				"referenceId": "230001-122218-000001",
+			},
+		},
+	})
+
+	docs.Then("and the expected protocol entries have been written")
+	tstRequireProtocolEntries(t, entity.ProtocolEntry{
+		ReferenceId: "230001-122218-000001",
+		ApiId:       4242,
+		Kind:        "error",
+		Message:     "webhook ref-id-prefix",
+		Details:     "ref-id=230001-122218-000001",
+	})
+}
+
 // --- helpers ---
 
 func tstWebhookSuccessCase(t *testing.T, status string, expectedPaymentServiceRecording []paymentservice.Transaction, expectedMailRecording []mailservice.MailSendDto, expectedProtocol []entity.ProtocolEntry) {

test/resources/testconfig.yaml

@@ -2,6 +2,7 @@ service:
   name: 'Registration Concardis Adapter Unit Testing Configuration'
   concardis_instance: 'myinstance'
   concardis_api_secret: 'mydemosecret'
+  transaction_id_prefix: "221216"
 database:
   use: inmemory
 security: