saleor/saleor

Provide better message for transactionAPI

Open

#13.951 geöffnet am 11. Sept. 2023

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (19.887 Stars) (5.278 Forks)batch import
good first issuetransactionAPI

Beschreibung

Problem

We can improve the message that we provide from transactionEventReport, and transaction API. This can give more context when analyzing the de-duplicated events. Add context (if possible) like:

  • amount
  • pspReference
  • event type returned by app

For example, transactionEventReport creates the event with message:

The transaction with provided `pspReference` and `type` already exists with different amount.

It doesn't contain enough details to determine the what type of the event we received, or what was the psp-reference which raised the error.

The mutation that should be checked transactionEventReport, transactionInitialize, transactionProcess, transactionCreate, transactionUpdate, transactionRequestAction. To any event created by Saleor implementation, we should provide more context. For example: instead of msg like: "Provided event type is invalid", we should have: f"Provided event type: {response.type} is invalid."

Acceptance Criteria

  • The events created by Saleor for transactionAPI includes the details (type, pspReference) required to analyze the flow

Contributor Guide

Tech Stack
pythondjangographql
Domain
backendapi
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
PythonDjangoGraphQL
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
Look into the mutation functions for transactionEventReport, transactionInitialize, transactionProcess, transactionCreate, transactionUpdate, and transactionRequestAction in Saleor's codebase, likely in saleor/graphql/transaction/. The goal is to add more context to error messages, such as including the pspReference and event type. Check existing error message patterns in the codebase for consistency. For example, change 'Provided event type is invalid' to f'Provided event type: {response.type} is invalid' as suggested in the issue.