Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b9b2a524dd | ||
|
|
e26331ffa9 | ||
|
|
99c74f49b6 | ||
|
|
cb5a09e710 | ||
|
|
4dfe139c3b | ||
|
|
aeb86f55b9 | ||
|
|
1969aaa1d2 | ||
|
|
c8cbd1e7a3 | ||
|
|
afb8bb0e9e |
@@ -29,6 +29,7 @@ _obj
|
|||||||
_test
|
_test
|
||||||
.vscode/
|
.vscode/
|
||||||
ChipDNAClient/
|
ChipDNAClient/
|
||||||
|
docs/
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
# Architecture specific extensions/prefixes
|
||||||
*.[568vq]
|
*.[568vq]
|
||||||
|
|||||||
+45
-14
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Deploy ChipDNAClientCLI, then hardlink, then Operafyne. No database or configuration
|
Deploy ChipDNAClientCLI, then hardlink, then Operafyne. No database or configuration
|
||||||
migration is needed. The existing CreditCall provider selection enables the new
|
migration is needed. The existing CreditCall provider selection enables the new
|
||||||
sale route; CreditCall does not implement the generic payment provider interface.
|
SALE and PREAUTH routes; CreditCall does not implement the generic payment provider interface.
|
||||||
|
|
||||||
## Contracts
|
## Contracts
|
||||||
|
|
||||||
@@ -10,6 +10,15 @@ sale route; CreditCall does not implement the generic payment provider interface
|
|||||||
`{"amount":1234,"confirmNo":"BOOKING-123","currency":"GBP"}`. Amount remains in
|
`{"amount":1234,"confirmNo":"BOOKING-123","currency":"GBP"}`. Amount remains in
|
||||||
minor units. CreditCall uses its existing SDK transaction reference generation.
|
minor units. CreditCall uses its existing SDK transaction reference generation.
|
||||||
|
|
||||||
|
`POST /api/payment/preauth` accepts string fields `amount`, `transactionType`
|
||||||
|
and `checkoutDate`. Positive preauth sends the existing `Sale` input and checkout
|
||||||
|
string; zero-value verification sends `{"amount":"","transactionType":"AccountVerification","checkoutDate":""}`.
|
||||||
|
The returned `ACCOUNT VERIFICATION` type is matched case-insensitively and succeeds
|
||||||
|
without persistence. Returned approved `SALE` schedules existing SQL persistence
|
||||||
|
using provider-returned `TOTAL_AMOUNT`, never the request amount. PREAUTH does not
|
||||||
|
confirm. Checkout remains departure-derived midnight UTC in the existing string
|
||||||
|
format; SQL's existing date conversion and 48-hour release calculation are unchanged.
|
||||||
|
|
||||||
For CreditCall, responses contain newline-delimited JSON:
|
For CreditCall, responses contain newline-delimited JSON:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
@@ -19,7 +28,7 @@ For CreditCall, responses contain newline-delimited JSON:
|
|||||||
|
|
||||||
`outcome` is `approved`, `declined`, `cancelled`, `timeout`, or `error`. Approval
|
`outcome` is `approved`, `declined`, `cancelled`, `timeout`, or `error`. Approval
|
||||||
is produced only by the shared CreditCall transaction/finalization core, including
|
is produced only by the shared CreditCall transaction/finalization core, including
|
||||||
the existing confirmation behavior. `httpStatus` preserves the equivalent legacy
|
SALE confirmation behavior; PREAUTH uses its existing unconfirmed-result rules. `httpStatus` preserves the equivalent legacy
|
||||||
operation status even after streaming commits HTTP 200. `status` preserves the
|
operation status even after streaming commits HTTP 200. `status` preserves the
|
||||||
existing processor `StatusRec`. Failure `message` preserves the plain description
|
existing processor `StatusRec`. Failure `message` preserves the plain description
|
||||||
used by the legacy flow, including its existing interpretation quirks.
|
used by the legacy flow, including its existing interpretation quirks.
|
||||||
@@ -31,20 +40,32 @@ continue using their existing `{"type":"result","response":...}` contract.
|
|||||||
|
|
||||||
Hardlink calls `POST /start-transaction-stream/` on ChipDNAClientCLI with
|
Hardlink calls `POST /start-transaction-stream/` on ChipDNAClientCLI with
|
||||||
`{"amount":"1234","transactionType":"Sale"}`. Its NDJSON consists of allowlisted
|
`{"amount":"1234","transactionType":"Sale"}`. Its NDJSON consists of allowlisted
|
||||||
`status` frames (`source`, `value`), a single `result` containing the required SDK
|
`status` frames (`source`, `value`), a single `result` containing allowlisted SDK
|
||||||
fields, or a sanitized `error`. Receipt XML may be a JSON string field needed by
|
fields, or a sanitized `error`. `TRANSACTION_TYPE` and optional `TOTAL_AMOUNT`
|
||||||
|
are included only when returned by the provider. They are never synthesized and
|
||||||
|
are not added to the kiosk-facing result. AccountVerification normally omits
|
||||||
|
`TOTAL_AMOUNT`. Receipt XML may be a JSON string field needed by
|
||||||
hardlink's existing receipt handler; it is never a raw line in the stream.
|
hardlink's existing receipt handler; it is never a raw line in the stream.
|
||||||
Confirmation continues through the existing, separate XML endpoint.
|
SALE confirmation continues through the existing, separate XML endpoint.
|
||||||
|
|
||||||
## Lifetime and compatibility
|
## Lifetime and compatibility
|
||||||
|
|
||||||
- `/start-transaction/`, `/takepayment`, and `/takepreauth` retain their existing
|
- `/start-transaction/`, `/takepayment`, and `/takepreauth` retain their existing
|
||||||
external contracts. Preauthorization and SQL persistence/release remain legacy.
|
external contracts. Both SALE and PREAUTH now stream to Operafyne; existing SQL
|
||||||
- Start and each confirmation call retain their independent 300-second timeout.
|
persistence/release behavior remains unchanged.
|
||||||
|
- Operafyne uses a private 120-second CreditCall client for SALE and PREAUTH.
|
||||||
|
This is only the kiosk wait boundary; Dojo/PayBridge clients are unchanged.
|
||||||
|
Timeout/cancellation is technical, not an authoritative decline or automatically
|
||||||
|
retryable result. It never triggers a second start or legacy endpoint fallback.
|
||||||
|
- Validation uses the inbound request. At financial dispatch handoff, hardlink
|
||||||
|
detaches cancellation with `context.WithoutCancel`. Inbound cancellation and
|
||||||
|
write failures control only delivery; result processing, SALE confirmation,
|
||||||
|
receipts and PREAUTH persistence scheduling continue independently.
|
||||||
|
- Start and each SALE confirmation call retain their independent 300-second timeout.
|
||||||
Confirmation still uses two attempts, retrying transport/read errors with the
|
Confirmation still uses two attempts, retrying transport/read errors with the
|
||||||
existing two-second delay. The generic whole-operation timeout is not used.
|
existing two-second delay. The generic whole-operation timeout is not used.
|
||||||
- Kiosk cancellation or failed/blocked kiosk delivery does not cancel upstream reading,
|
- Kiosk cancellation or failed/blocked kiosk delivery does not cancel upstream reading,
|
||||||
confirmation, or receipt handling. Progress queues may drop hints when full;
|
confirmation, receipt handling, or PREAUTH persistence scheduling. Progress queues may drop hints when full;
|
||||||
final results have a separate slot and are delivered at most once.
|
final results have a separate slot and are delivered at most once.
|
||||||
- Only the response writer writes frames. Transaction execution never waits
|
- Only the response writer writes frames. Transaction execution never waits
|
||||||
for progress delivery. No additional delivery timer or whole-operation deadline
|
for progress delivery. No additional delivery timer or whole-operation deadline
|
||||||
@@ -55,17 +76,20 @@ Confirmation continues through the existing, separate XML endpoint.
|
|||||||
observational window. A supplied nonempty reference must match. The window opens
|
observational window. A supplied nonempty reference must match. The window opens
|
||||||
immediately before the SDK start call and closes immediately at
|
immediately before the SDK start call and closes immediately at
|
||||||
`TransactionFinished`; finalization never waits for card removal.
|
`TransactionFinished`; finalization never waits for card removal.
|
||||||
- Unidentified `CardRemovalRequested` and `CardRemovalEnforced` updates are omitted
|
- `CardRemovalRequested` and `CardRemovalEnforced` follow the same active-window
|
||||||
because they can arrive after financial completion. They require a matching
|
rule as other progress, including when no reference is supplied. Real Miura
|
||||||
explicit reference. `Removed` remains omitted even with a reference.
|
insertion-recovery sequences can repeat present-card and remove-card prompts
|
||||||
|
within one transaction; these repeated prompts are not deduplicated. Outside
|
||||||
|
the active window they are discarded. `Removed` remains omitted even with a
|
||||||
|
reference, and the existing `Inserted` mapping is unchanged.
|
||||||
- Ownership is best-effort UI observation. SDK 3.17 does not establish that every
|
- Ownership is best-effort UI observation. SDK 3.17 does not establish that every
|
||||||
queued reference-less non-removal callback has drained before another transaction
|
queued reference-less callback, including removal, has drained before another transaction
|
||||||
starts. Such a callback may briefly display stale progress in a later active
|
starts. Such a callback may briefly display stale progress in a later active
|
||||||
window. This accepted limitation must never affect success, decline, cancellation,
|
window. This accepted limitation must never affect success, decline, cancellation,
|
||||||
timeout outcomes, confirmation, retry, receipts, PMS posting, or business state.
|
timeout outcomes, confirmation, retry, receipts, PMS posting, or business state.
|
||||||
- After timeout, an ambiguous start error, an asynchronous SDK error during an
|
- After timeout, an ambiguous start error, an asynchronous SDK error during an
|
||||||
active window, or reference reuse/overlap, progress remains suppressed for that
|
active window, or reference reuse/overlap, progress remains suppressed for that
|
||||||
`Client` lifetime. New transactions, elapsed time, callbacks and automatic
|
`Client` lifetime across SALE and PREAUTH. New transactions, elapsed time, callbacks and automatic
|
||||||
reconnect do not reset the guard. Payments remain enabled.
|
reconnect do not reset the guard. Payments remain enabled.
|
||||||
- Only the exact synchronous `ClientNotConnectedToServer` error safely clears an
|
- Only the exact synchronous `ClientNotConnectedToServer` error safely clears an
|
||||||
unsuppressed window and releases its unused reference: SDK 3.17 `StartCommand`
|
unsuppressed window and releases its unused reference: SDK 3.17 `StartCommand`
|
||||||
@@ -88,6 +112,13 @@ with MSBuild, then run `Tests/bin/Debug/ChipDNAClient.StreamingTests.exe`. The
|
|||||||
test executable links the production streaming code and needs no terminal.
|
test executable links the production streaming code and needs no terminal.
|
||||||
|
|
||||||
In Operafyne, run `go test -count=1 ./...`; the service tests cover structured
|
In Operafyne, run `go test -count=1 ./...`; the service tests cover structured
|
||||||
CreditCall sales, unchanged preauth requests, failure/retry parity, and existing
|
CreditCall SALE/PREAUTH, unchanged legacy requests, the 120-second UX boundary,
|
||||||
|
cancellation after dispatch, failure/retry parity, and existing
|
||||||
Dojo/PayBridge response handling. Run `go vet ./...`, `go build ./...`, and
|
Dojo/PayBridge response handling. Run `go vet ./...`, `go build ./...`, and
|
||||||
`git diff --check` in both Go repositories.
|
`git diff --check` in both Go repositories.
|
||||||
|
|
||||||
|
Physical account-verification testing confirmed approved `ACCOUNT VERIFICATION`
|
||||||
|
with no `TOTAL_AMOUNT`. A monetary `/takepayment` test confirmed returned minor
|
||||||
|
units; positive PREAUTH through the new transport still needs physical Miura
|
||||||
|
validation. Automated tests do not replace that check. Receipt fields such as
|
||||||
|
`NoChargeDeclaration` retain the existing provider-entry rendering behavior.
|
||||||
|
|||||||
@@ -33,7 +33,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
buildVersion = "v2.0.0"
|
buildVersion = "v2.1.0"
|
||||||
serviceName = "hardlink"
|
serviceName = "hardlink"
|
||||||
pollingFrequency = 8 * time.Second
|
pollingFrequency = 8 * time.Second
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -125,6 +125,15 @@ func BuildPaymentRedirectURL(result map[string]string) string {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func BuildPreauthRedirectURL(result map[string]string) (string, bool) {
|
func BuildPreauthRedirectURL(result map[string]string) (string, bool) {
|
||||||
|
approved, persist := PreauthDecision(result)
|
||||||
|
if approved {
|
||||||
|
return BuildSuccessURL(result), persist
|
||||||
|
}
|
||||||
|
return BuildFailureURL(result[types.TransactionResult], result[types.Errors]), false
|
||||||
|
}
|
||||||
|
|
||||||
|
// PreauthDecision preserves the returned-type approval and persistence rules.
|
||||||
|
func PreauthDecision(result map[string]string) (approved, persist bool) {
|
||||||
res := result[types.TransactionResult]
|
res := result[types.TransactionResult]
|
||||||
tType := result[types.TransactionType]
|
tType := result[types.TransactionType]
|
||||||
|
|
||||||
@@ -136,7 +145,7 @@ func BuildPreauthRedirectURL(result map[string]string) (string, bool) {
|
|||||||
log.WithField(types.LogResult, result[types.TransactionResult]).
|
log.WithField(types.LogResult, result[types.TransactionResult]).
|
||||||
Info("Account verification approved")
|
Info("Account verification approved")
|
||||||
|
|
||||||
return BuildSuccessURL(result), false
|
return true, false
|
||||||
|
|
||||||
// Transaction type Sale?
|
// Transaction type Sale?
|
||||||
case strings.EqualFold(tType, types.SaleTransactionType):
|
case strings.EqualFold(tType, types.SaleTransactionType):
|
||||||
@@ -144,12 +153,12 @@ func BuildPreauthRedirectURL(result map[string]string) (string, bool) {
|
|||||||
log.WithField(types.LogResult, result[types.ConfirmResult]).
|
log.WithField(types.LogResult, result[types.ConfirmResult]).
|
||||||
Info("Amount preauthorized successfully")
|
Info("Amount preauthorized successfully")
|
||||||
|
|
||||||
return BuildSuccessURL(result), true
|
return true, true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Not approved
|
// Not approved
|
||||||
return BuildFailureURL(res, result[types.Errors]), false
|
return false, false
|
||||||
}
|
}
|
||||||
|
|
||||||
func BuildSuccessURL(result map[string]string) string {
|
func BuildSuccessURL(result map[string]string) string {
|
||||||
|
|||||||
@@ -0,0 +1,35 @@
|
|||||||
|
package creditcall
|
||||||
|
|
||||||
|
import (
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.futuresens.co.uk/futuresens/hardlink/internal/types"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestPreauthLegacyDecision(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name, result, kind string
|
||||||
|
approved, save bool
|
||||||
|
}{
|
||||||
|
{"sale", "APPROVED", "SALE", true, true},
|
||||||
|
{"verification", "APPROVED", "ACCOUNT VERIFICATION", true, false},
|
||||||
|
{"mixed case", "Approved", "Account Verification", true, false},
|
||||||
|
{"request spelling is not result spelling", "APPROVED", "AccountVerification", false, false},
|
||||||
|
{"missing type", "APPROVED", "", false, false},
|
||||||
|
{"declined sale", "DECLINED", "SALE", false, false},
|
||||||
|
{"declined verification", "DECLINED", "ACCOUNT VERIFICATION", false, false},
|
||||||
|
{"missing result", "", "SALE", false, false},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
fields := map[string]string{types.TransactionResult: tc.result, types.TransactionType: tc.kind, types.Errors: "provider detail"}
|
||||||
|
redirect, save := BuildPreauthRedirectURL(fields)
|
||||||
|
if strings.HasPrefix(redirect, "/successful?") != tc.approved || save != tc.save {
|
||||||
|
t.Errorf("BuildPreauthRedirectURL(%v) = %q,%t, want approved=%t save=%t", fields, redirect, save, tc.approved, tc.save)
|
||||||
|
}
|
||||||
|
if _, ok := fields[types.TotalAmount]; ok {
|
||||||
|
t.Error("BuildPreauthRedirectURL fabricated TOTAL_AMOUNT")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,363 @@
|
|||||||
|
package dispenser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"reflect"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func apReply(st []byte) []byte {
|
||||||
|
frame := []byte{STX, 0x30, 0x30, 0, byte(len(st) + 2), 'S', 'F'}
|
||||||
|
frame = append(frame, st...)
|
||||||
|
frame = append(frame, ETX)
|
||||||
|
return append(frame, calculateBCC(frame))
|
||||||
|
}
|
||||||
|
|
||||||
|
func workerRequest(c *Client, ctx context.Context, typ cmdType) cmdResp {
|
||||||
|
ch := make(chan cmdResp, 1)
|
||||||
|
c.handle(cmdReq{typ: typ, ctx: ctx, respCh: ch})
|
||||||
|
return <-ch
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliveryDispatchBoundary(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
short int
|
||||||
|
badACK bool
|
||||||
|
cancelAfter int
|
||||||
|
pending bool
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{name: "success", pending: true},
|
||||||
|
{name: "command short write", short: 1, wantErr: true},
|
||||||
|
{name: "bad ACK", badACK: true, wantErr: true},
|
||||||
|
{name: "ENQ short write", short: 2, pending: true, wantErr: true},
|
||||||
|
{name: "cancel before ENQ", cancelAfter: 1, wantErr: true},
|
||||||
|
{name: "cancel after ENQ", cancelAfter: 2, pending: true, wantErr: true},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
ack := append([]byte(nil), vendorACK...)
|
||||||
|
if tc.badACK {
|
||||||
|
ack[0] = 0
|
||||||
|
}
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{ack}, shortWrite: tc.short}
|
||||||
|
p.afterWrite = func() {
|
||||||
|
if len(p.writes) == tc.cancelAfter {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c := &Client{port: p}
|
||||||
|
r := workerRequest(c, ctx, cmdOutOfMouth)
|
||||||
|
if (r.err != nil) != tc.wantErr || c.deliveryPending != tc.pending {
|
||||||
|
t.Errorf("FC0(%s): err=%v pending=%v, want error=%v pending=%v", tc.name, r.err, c.deliveryPending, tc.wantErr, tc.pending)
|
||||||
|
}
|
||||||
|
if len(p.writes) > 2 {
|
||||||
|
t.Errorf("FC0 writes=%d, want no resend", len(p.writes))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
t.Run("definite failure preserves previous pending", func(t *testing.T) {
|
||||||
|
c := &Client{port: &scriptedTransport{writeErr: io.ErrClosedPipe}, deliveryPending: true}
|
||||||
|
workerRequest(c, context.Background(), cmdOutOfMouth)
|
||||||
|
if !c.deliveryPending {
|
||||||
|
t.Error("failed FC0 erased previous pending")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
t.Run("ENQ transport error remains pending", func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK}}
|
||||||
|
p.afterWrite = func() {
|
||||||
|
if len(p.writes) == 2 {
|
||||||
|
p.writeErr = io.ErrClosedPipe
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c := &Client{port: p}
|
||||||
|
r := workerRequest(c, context.Background(), cmdOutOfMouth)
|
||||||
|
if !errors.Is(r.err, io.ErrClosedPipe) || !c.deliveryPending {
|
||||||
|
t.Errorf("ENQ error=%v pending=%v, want closed pipe and pending", r.err, c.deliveryPending)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWorkerClearanceValidation(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
st []byte
|
||||||
|
clear bool
|
||||||
|
}{
|
||||||
|
{"clear", status(0x30), true},
|
||||||
|
{"low stock clear", []byte{0x30, 0x30, 0x31, 0x30}, true},
|
||||||
|
{"residual encoder", status(0x33), false},
|
||||||
|
{"all sensors", status(0x37), false},
|
||||||
|
{"ready", status(0x34), true},
|
||||||
|
{"unknown diagnostic", []byte{0x30, 0x30, 0xFF, 0x30}, true},
|
||||||
|
{"jam", []byte{0x30, 0x30, 0x32, 0x30}, true},
|
||||||
|
{"overlap", []byte{0x30, 0x30, 0x34, 0x30}, true},
|
||||||
|
{"rejection", []byte{0x36, 0x30, 0x30, 0x30}, true},
|
||||||
|
{"empty", status(0x38), false},
|
||||||
|
{"preparing", []byte{0x31, 0x30, 0x30, 0x30}, false},
|
||||||
|
{"dispensing", []byte{0x30, 0x38, 0x30, 0x34}, false},
|
||||||
|
{"capturing", []byte{0x30, 0x34, 0x30, 0x30}, false},
|
||||||
|
{"ready with stale errors", []byte{0x36, 0x32, 0x34, 0x34}, true},
|
||||||
|
{"short payload", []byte{0x30, 0x30, 0x30}, false},
|
||||||
|
{"unknown position", status(0x40), false},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, apReply(tc.st), vendorACK}}
|
||||||
|
c := &Client{port: p, deliveryPending: true, deliveryStarted: time.Now().Add(-deliveryMinimumWait), lastStatus: status(0x30), lastStatusT: time.Now(), statusTTL: time.Hour}
|
||||||
|
r := workerRequest(c, context.Background(), cmdStatus)
|
||||||
|
if c.deliveryPending == tc.clear {
|
||||||
|
t.Errorf("FC7(% X): err=%v pending=%v, want clear=%v", tc.st, r.err, c.deliveryPending, tc.clear)
|
||||||
|
}
|
||||||
|
want := []string{"AP"}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("commands=%v, want %v", got, want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
t.Run("bad BCC cannot clear", func(t *testing.T) {
|
||||||
|
frame := apReply(status(0x30))
|
||||||
|
frame[len(frame)-1] ^= 1
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, frame}}
|
||||||
|
c := &Client{port: p, deliveryPending: true}
|
||||||
|
r := workerRequest(c, context.Background(), cmdStatus)
|
||||||
|
if r.err == nil || !c.deliveryPending {
|
||||||
|
t.Errorf("bad BCC: err=%v pending=%v", r.err, c.deliveryPending)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func wireCommands(p *scriptedTransport) []string {
|
||||||
|
var commands []string
|
||||||
|
for _, w := range p.writes {
|
||||||
|
if len(w) > 6 && w[0] == STX {
|
||||||
|
commands = append(commands, string(w[5:len(w)-2]))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return commands
|
||||||
|
}
|
||||||
|
|
||||||
|
func deliveryWorkerClient(t *testing.T, p *scriptedTransport) (*Client, *time.Time) {
|
||||||
|
t.Helper()
|
||||||
|
transportAddress(t)
|
||||||
|
now := time.Unix(0, 0)
|
||||||
|
c := &Client{port: p, reqCh: make(chan cmdReq, 16), done: make(chan struct{})}
|
||||||
|
c.sequenceTiming = sequenceTiming{now: func() time.Time { return now }, wait: func(ctx context.Context, d time.Duration) error {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
now = now.Add(d)
|
||||||
|
return nil
|
||||||
|
}}
|
||||||
|
stopped := make(chan struct{})
|
||||||
|
go func() { defer close(stopped); c.loop() }()
|
||||||
|
t.Cleanup(func() { c.Close(); <-stopped })
|
||||||
|
return c, &now
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliveryIncidentReplay(t *testing.T) {
|
||||||
|
for _, next := range []bool{false, true} {
|
||||||
|
t.Run(map[bool]string{false: "current", true: "next"}[next], func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{
|
||||||
|
vendorACK, apReply(status(0x33)), // current card at encoder; encoding succeeds
|
||||||
|
vendorACK, // FC0
|
||||||
|
vendorACK, apReply(status(0x37)), // best effort must defer
|
||||||
|
vendorACK, apReply(status(0x33)), // previous encoder sensor must not succeed
|
||||||
|
vendorACK, apReply(status(0x34)),
|
||||||
|
vendorACK, // FC7
|
||||||
|
vendorACK, apReply(status(0x33)),
|
||||||
|
}}
|
||||||
|
c, now := deliveryWorkerClient(t, p)
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := c.DeliverCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
// A cached clear result must not authorize FC7.
|
||||||
|
c.mu.Lock()
|
||||||
|
c.lastStatus = status(0x30)
|
||||||
|
c.lastStatusT = time.Now()
|
||||||
|
c.statusTTL = time.Hour
|
||||||
|
c.mu.Unlock()
|
||||||
|
if err := c.BeginPrepareNextCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, []string{"AP", "FC0", "AP", "AP", "AP", "FC7"}) {
|
||||||
|
t.Fatalf("prestaging commands=%v, want clearance APs then one FC7", got)
|
||||||
|
}
|
||||||
|
prepare := c.PrepareCurrentCard
|
||||||
|
if next {
|
||||||
|
prepare = c.PrepareNextCard
|
||||||
|
}
|
||||||
|
if _, err := prepare(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []string{"AP", "FC0", "AP", "AP", "AP", "FC7", "AP"}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("incident commands=%v, want %v", got, want)
|
||||||
|
}
|
||||||
|
if elapsed := now.Sub(time.Unix(0, 0)); elapsed != 2*time.Second {
|
||||||
|
t.Errorf("clearance waits=%s, want 2s", elapsed)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliveryClearWaitsTwoSeconds(t *testing.T) {
|
||||||
|
for _, position := range []byte{0x30, 0x34} {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK,
|
||||||
|
vendorACK, apReply(status(position)), vendorACK, apReply(status(position)), vendorACK, apReply(status(position)),
|
||||||
|
vendorACK, vendorACK, apReply(status(0x37))}}
|
||||||
|
c, now := deliveryWorkerClient(t, p)
|
||||||
|
if _, err := c.DeliverCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []string{"FC0", "AP", "AP", "AP", "FC7", "AP"}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("clearance %X commands=%v, want %v", position, got, want)
|
||||||
|
}
|
||||||
|
if elapsed := now.Sub(time.Unix(0, 0)); elapsed != deliveryMinimumWait {
|
||||||
|
t.Errorf("clearance %X elapsed=%s, want 2s", position, elapsed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliveryPendingIsNotPersisted(t *testing.T) {
|
||||||
|
c := NewClient(nil, 1)
|
||||||
|
defer c.Close()
|
||||||
|
if c.deliveryPending {
|
||||||
|
t.Error("new Client has pending delivery")
|
||||||
|
}
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, apReply(status(0x37))}}
|
||||||
|
fresh, _ := deliveryWorkerClient(t, p)
|
||||||
|
if _, err := fresh.PrepareCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Errorf("fresh client encoder status: %v", err)
|
||||||
|
}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, []string{"AP"}) {
|
||||||
|
t.Errorf("restart commands=%v, want AP only", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliveryCancellationAfterACKDoesNotSetPending(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK}, afterRead: cancel}
|
||||||
|
c := &Client{port: p}
|
||||||
|
r := workerRequest(c, ctx, cmdOutOfMouth)
|
||||||
|
if !errors.Is(r.err, context.Canceled) || c.deliveryPending || len(p.writes) != 1 {
|
||||||
|
t.Errorf("cancel after ACK: err=%v pending=%v writes=%d, want canceled, false, 1", r.err, c.deliveryPending, len(p.writes))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWorkerSerializesClearanceAndFC7(t *testing.T) {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, apReply(status(0x30)), vendorACK, vendorACK, vendorACK, apReply(status(0x37))}}
|
||||||
|
c, _ := deliveryWorkerClient(t, p)
|
||||||
|
// Set initial state before any request can reach the worker.
|
||||||
|
c.deliveryPending = true
|
||||||
|
c.deliveryStarted = c.now().Add(-deliveryMinimumWait)
|
||||||
|
reading := make(chan struct{})
|
||||||
|
resume := make(chan struct{})
|
||||||
|
p.afterWrite = func() {
|
||||||
|
if len(p.writes) == 1 {
|
||||||
|
close(reading)
|
||||||
|
<-resume
|
||||||
|
}
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||||
|
defer cancel()
|
||||||
|
fc7 := make(chan error, 1)
|
||||||
|
go func() { fc7 <- c.BeginPrepareNextCard(ctx) }()
|
||||||
|
select {
|
||||||
|
case <-reading:
|
||||||
|
case <-ctx.Done():
|
||||||
|
t.Fatal("worker did not begin AP")
|
||||||
|
}
|
||||||
|
fc0 := make(chan cmdResp, 1)
|
||||||
|
// This FC0 is queued while AP is in progress. It must not slip between
|
||||||
|
// the clearance observation and FC7 dispatch.
|
||||||
|
c.reqCh <- cmdReq{typ: cmdOutOfMouth, ctx: ctx, respCh: fc0}
|
||||||
|
close(resume)
|
||||||
|
if err := <-fc7; err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if r := <-fc0; r.err != nil {
|
||||||
|
t.Fatal(r.err)
|
||||||
|
}
|
||||||
|
|
||||||
|
want := []string{"AP", "FC7", "FC0"}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("serialized commands=%v, want %v", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDeliveryCancellationAfterFreshAPKeepsPending(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, apReply(status(0x34))}}
|
||||||
|
p.afterRead = func() {
|
||||||
|
if len(p.chunks) == 0 {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c := &Client{port: p, deliveryPending: true, deliveryStarted: time.Now().Add(-time.Minute)}
|
||||||
|
r := workerRequest(c, ctx, cmdToEncoder)
|
||||||
|
if !errors.Is(r.err, context.Canceled) || !c.deliveryPending {
|
||||||
|
t.Errorf("AP cancellation err=%v pending=%t, want canceled and pending", r.err, c.deliveryPending)
|
||||||
|
}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, []string{"AP"}) {
|
||||||
|
t.Errorf("cancelled clearance commands=%v, want AP only", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationWireFailuresNeverShake(t *testing.T) {
|
||||||
|
badBCC := apReply(status(0x30))
|
||||||
|
badBCC[len(badBCC)-1] ^= 1
|
||||||
|
for _, frame := range [][]byte{nil, apReply(status(0x30))[:8], badBCC, apReply(status(0x40))} {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, apReply(status(0x30)), vendorACK, vendorACK}}
|
||||||
|
if frame != nil {
|
||||||
|
p.chunks = append(p.chunks, frame)
|
||||||
|
}
|
||||||
|
c, _ := deliveryWorkerClient(t, p)
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Errorf("frame % X: err=%v, want encoder opportunity", frame, err)
|
||||||
|
}
|
||||||
|
want := []string{"AP", "FC7", "AP", "AP", "AP", "AP", "AP"}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("frame % X commands=%v, want %v without RS or resends", frame, got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBeginPrepareNextCardWaitsForClearanceWithoutReadinessPolling(t *testing.T) {
|
||||||
|
for _, position := range []byte{0x30, 0x34} {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK,
|
||||||
|
vendorACK, apReply(status(position)), vendorACK, apReply(status(position)), vendorACK, apReply(status(position)),
|
||||||
|
vendorACK}}
|
||||||
|
c, now := deliveryWorkerClient(t, p)
|
||||||
|
if _, err := c.DeliverCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := c.BeginPrepareNextCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
want := []string{"FC0", "AP", "AP", "AP", "FC7"}
|
||||||
|
if got := wireCommands(p); !reflect.DeepEqual(got, want) {
|
||||||
|
t.Errorf("BeginPrepareNextCard(%X) commands = %v, want %v", position, got, want)
|
||||||
|
}
|
||||||
|
if elapsed := now.Sub(time.Unix(0, 0)); elapsed != deliveryMinimumWait {
|
||||||
|
t.Errorf("BeginPrepareNextCard(%X) waited %s, want %s", position, elapsed, deliveryMinimumWait)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
+191
-109
@@ -1,8 +1,11 @@
|
|||||||
package dispenser
|
package dispenser
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/binary"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"io"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -27,14 +30,25 @@ const (
|
|||||||
CardWellEmptyMessage = "Card well is empty"
|
CardWellEmptyMessage = "Card well is empty"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
positionPreDispense = 0x01
|
||||||
|
positionEncoder = 0x02
|
||||||
|
positionMouth = 0x04
|
||||||
|
positionEmpty = 0x08
|
||||||
|
)
|
||||||
|
|
||||||
var (
|
var (
|
||||||
ErrCardWellEmpty = errors.New(CardWellEmptyMessage)
|
ErrCardWellEmpty = errors.New(CardWellEmptyMessage)
|
||||||
|
|
||||||
|
// ErrPreparationExhausted permits a new, independent UI preparation attempt.
|
||||||
|
ErrPreparationExhausted = errors.New("card preparation exhausted")
|
||||||
|
|
||||||
SerialPort string
|
SerialPort string
|
||||||
Address []byte
|
Address []byte
|
||||||
|
|
||||||
commandFC7 = []byte{ETX, 0x46, 0x43, 0x37} // "FC7"
|
commandFC7 = []byte{ETX, 0x46, 0x43, 0x37} // "FC7"
|
||||||
commandFC0 = []byte{ETX, 0x46, 0x43, 0x30} // "FC0"
|
commandFC0 = []byte{ETX, 0x46, 0x43, 0x30} // "FC0"
|
||||||
|
commandRS = []byte{0x02, 0x52, 0x53} // Length 2, "RS"
|
||||||
|
|
||||||
statusPos0 = map[byte]string{
|
statusPos0 = map[byte]string{
|
||||||
0x38: "Keep",
|
0x38: "Keep",
|
||||||
@@ -58,20 +72,21 @@ var (
|
|||||||
0x31: "Card pre-empty",
|
0x31: "Card pre-empty",
|
||||||
0x30: "Normal",
|
0x30: "Normal",
|
||||||
}
|
}
|
||||||
statusPos3 = map[byte]string{
|
|
||||||
0x38: "Card empty",
|
|
||||||
0x34: "Card ready position",
|
|
||||||
0x33: "Card at encoder position",
|
|
||||||
0x32: "Card at hold card position",
|
|
||||||
0x31: "Card out of card mouth position",
|
|
||||||
0x30: "Normal",
|
|
||||||
}
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// --------------------
|
// --------------------
|
||||||
// Status helpers
|
// Status helpers
|
||||||
// --------------------
|
// --------------------
|
||||||
|
|
||||||
|
// decodePositionStatus decodes the manual's 0x30 + combined sensor/empty flags.
|
||||||
|
// Sensor 2 (0x02) is the read position; sensor 1 and sensor 2 together give 0x33.
|
||||||
|
func decodePositionStatus(value byte) (flags byte, valid bool) {
|
||||||
|
if value&0xF0 != 0x30 {
|
||||||
|
return 0, false
|
||||||
|
}
|
||||||
|
return value & 0x0F, true
|
||||||
|
}
|
||||||
|
|
||||||
func statusDescription(statusBytes []byte) string {
|
func statusDescription(statusBytes []byte) string {
|
||||||
if len(statusBytes) < 4 {
|
if len(statusBytes) < 4 {
|
||||||
return fmt.Sprintf("<invalid len=%d>", len(statusBytes))
|
return fmt.Sprintf("<invalid len=%d>", len(statusBytes))
|
||||||
@@ -85,7 +100,6 @@ func statusDescription(statusBytes []byte) string {
|
|||||||
{pos: 1, value: statusBytes[0], mapper: statusPos0},
|
{pos: 1, value: statusBytes[0], mapper: statusPos0},
|
||||||
{pos: 2, value: statusBytes[1], mapper: statusPos1},
|
{pos: 2, value: statusBytes[1], mapper: statusPos1},
|
||||||
{pos: 3, value: statusBytes[2], mapper: statusPos2},
|
{pos: 3, value: statusBytes[2], mapper: statusPos2},
|
||||||
{pos: 4, value: statusBytes[3], mapper: statusPos3},
|
|
||||||
}
|
}
|
||||||
|
|
||||||
var result strings.Builder
|
var result strings.Builder
|
||||||
@@ -98,6 +112,24 @@ func statusDescription(statusBytes []byte) string {
|
|||||||
result.WriteString(statusMsg + "; ")
|
result.WriteString(statusMsg + "; ")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
flags, valid := decodePositionStatus(statusBytes[3])
|
||||||
|
if !valid {
|
||||||
|
fmt.Fprintf(&result, "Unknown status 0x%X at position 4; ", statusBytes[3])
|
||||||
|
} else {
|
||||||
|
for _, position := range []struct {
|
||||||
|
mask byte
|
||||||
|
text string
|
||||||
|
}{
|
||||||
|
{positionPreDispense, "Card at pre-dispense position"},
|
||||||
|
{positionEncoder, "Card at encoder position"},
|
||||||
|
{positionMouth, "Card at mouth position"},
|
||||||
|
{positionEmpty, "Card empty"},
|
||||||
|
} {
|
||||||
|
if flags&position.mask != 0 {
|
||||||
|
result.WriteString(position.text + "; ")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
return result.String()
|
return result.String()
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -106,38 +138,42 @@ func logStatus(statusBytes []byte) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func isAtEncoderPosition(statusBytes []byte) bool {
|
func isAtEncoderPosition(statusBytes []byte) bool {
|
||||||
return len(statusBytes) >= 4 && statusBytes[3] == 0x33
|
if len(statusBytes) < 4 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
flags, valid := decodePositionStatus(statusBytes[3])
|
||||||
|
return valid && flags&positionEncoder != 0
|
||||||
}
|
}
|
||||||
|
|
||||||
func validateDispenserStatusData(statusBytes []byte) error {
|
type preparationClass string
|
||||||
if len(statusBytes) != 4 {
|
|
||||||
return fmt.Errorf("malformed dispenser status: got %d bytes, want 4", len(statusBytes))
|
|
||||||
}
|
|
||||||
|
|
||||||
statusMaps := []map[byte]string{statusPos0, statusPos1, statusPos2, statusPos3}
|
const (
|
||||||
for position, mapper := range statusMaps {
|
encoderConfirmed preparationClass = "encoder confirmed"
|
||||||
if _, ok := mapper[statusBytes[position]]; !ok {
|
positionUncertain preparationClass = "valid but uncertain"
|
||||||
return fmt.Errorf("unknown dispenser status 0x%X at position %d", statusBytes[position], position+1)
|
positionWellEmpty preparationClass = "empty"
|
||||||
}
|
positionNoCard preparationClass = "no card on sensors"
|
||||||
}
|
)
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func dispenserStatusError(statusBytes []byte) error {
|
// classifyPreparationStatus is the only readiness gate after AP wire validation.
|
||||||
switch statusBytes[0] {
|
// Diagnostics describe the device; they do not veto a physical position class.
|
||||||
case 0x34, 0x32, 0x36:
|
func classifyPreparationStatus(status []byte) (preparationClass, error) {
|
||||||
return fmt.Errorf("dispenser error: %s", statusPos0[statusBytes[0]])
|
if len(status) != 4 {
|
||||||
|
return "", fmt.Errorf("malformed dispenser status: got %d bytes, want 4", len(status))
|
||||||
}
|
}
|
||||||
switch statusBytes[1] {
|
flags, valid := decodePositionStatus(status[3])
|
||||||
case 0x32, 0x31:
|
if !valid {
|
||||||
return fmt.Errorf("dispenser error: %s", statusPos1[statusBytes[1]])
|
return "", fmt.Errorf("malformed dispenser position encoding: 0x%X", status[3])
|
||||||
}
|
}
|
||||||
switch statusBytes[2] {
|
switch {
|
||||||
case 0x34, 0x32:
|
case flags&positionEncoder != 0:
|
||||||
return fmt.Errorf("dispenser error: %s", statusPos2[statusBytes[2]])
|
return encoderConfirmed, nil
|
||||||
|
case status[3] == 0x38:
|
||||||
|
return positionWellEmpty, nil
|
||||||
|
case status[3] == 0x30:
|
||||||
|
return positionNoCard, nil
|
||||||
|
default:
|
||||||
|
return positionUncertain, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func isPreparationMoving(statusBytes []byte) bool {
|
func isPreparationMoving(statusBytes []byte) bool {
|
||||||
@@ -145,11 +181,6 @@ func isPreparationMoving(statusBytes []byte) bool {
|
|||||||
(statusBytes[0] == 0x31 || statusBytes[1] == 0x38)
|
(statusBytes[0] == 0x31 || statusBytes[1] == 0x38)
|
||||||
}
|
}
|
||||||
|
|
||||||
func hasPreparationDiagnostics(statusBytes []byte) bool {
|
|
||||||
return len(statusBytes) == 4 &&
|
|
||||||
(statusBytes[0] != 0x30 || statusBytes[1] != 0x30 || statusBytes[2] != 0x30)
|
|
||||||
}
|
|
||||||
|
|
||||||
func stockTake(statusBytes []byte) string {
|
func stockTake(statusBytes []byte) string {
|
||||||
if len(statusBytes) < 4 {
|
if len(statusBytes) < 4 {
|
||||||
return ""
|
return ""
|
||||||
@@ -161,14 +192,18 @@ func stockTake(statusBytes []byte) string {
|
|||||||
if statusBytes[2] != 0x30 {
|
if statusBytes[2] != 0x30 {
|
||||||
status = statusPos2[statusBytes[2]]
|
status = statusPos2[statusBytes[2]]
|
||||||
}
|
}
|
||||||
if statusBytes[3] == 0x38 {
|
if isCardWellEmpty(statusBytes) {
|
||||||
status = statusPos3[statusBytes[3]]
|
status = "Card empty"
|
||||||
}
|
}
|
||||||
return status
|
return status
|
||||||
}
|
}
|
||||||
|
|
||||||
func isCardWellEmpty(statusBytes []byte) bool {
|
func isCardWellEmpty(statusBytes []byte) bool {
|
||||||
return len(statusBytes) >= 4 && statusBytes[3] == 0x38
|
if len(statusBytes) < 4 {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
flags, valid := decodePositionStatus(statusBytes[3])
|
||||||
|
return valid && flags&positionEmpty != 0
|
||||||
}
|
}
|
||||||
|
|
||||||
func checkACK(statusResp []byte) error {
|
func checkACK(statusResp []byte) error {
|
||||||
@@ -207,20 +242,105 @@ func createPacket(address []byte, command []byte) []byte {
|
|||||||
|
|
||||||
func buildCheckAP(address []byte) []byte { return createPacket(address, []byte{STX, 0x41, 0x50}) }
|
func buildCheckAP(address []byte) []byte { return createPacket(address, []byte{STX, 0x41, 0x50}) }
|
||||||
|
|
||||||
func sendAndReceive(port *serial.Port, packet []byte, delay time.Duration) ([]byte, error) {
|
// serialTransport is used only by the serial-port owner.
|
||||||
_, err := port.Write(packet)
|
type serialTransport interface {
|
||||||
if err != nil {
|
io.Reader
|
||||||
return nil, fmt.Errorf("error writing to port: %w", err)
|
io.Writer
|
||||||
}
|
}
|
||||||
|
|
||||||
time.Sleep(delay)
|
func writePacket(ctx context.Context, port serialTransport, packet []byte) error {
|
||||||
|
_, err := writePacketAttempt(ctx, port, packet)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
buf := make([]byte, 128)
|
// writePacketAttempt distinguishes cancellation before Write from an ambiguous write.
|
||||||
n, err := port.Read(buf)
|
func writePacketAttempt(ctx context.Context, port serialTransport, packet []byte) (bool, error) {
|
||||||
if err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
return nil, fmt.Errorf("error reading from port: %w", err)
|
return false, err
|
||||||
}
|
}
|
||||||
return buf[:n], nil
|
n, err := port.Write(packet)
|
||||||
|
if err != nil {
|
||||||
|
return true, fmt.Errorf("write dispenser packet: %w", err)
|
||||||
|
}
|
||||||
|
if n != len(packet) {
|
||||||
|
return true, fmt.Errorf("write dispenser packet (%d/%d bytes): %w", n, len(packet), io.ErrShortWrite)
|
||||||
|
}
|
||||||
|
return true, ctx.Err()
|
||||||
|
}
|
||||||
|
|
||||||
|
func readExact(ctx context.Context, port serialTransport, data []byte) error {
|
||||||
|
for len(data) > 0 {
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
n, err := port.Read(data)
|
||||||
|
data = data[n:]
|
||||||
|
if ctxErr := ctx.Err(); ctxErr != nil {
|
||||||
|
return ctxErr
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("read dispenser response: %w", err)
|
||||||
|
}
|
||||||
|
if n == 0 {
|
||||||
|
return fmt.Errorf("read dispenser response: %w", io.ErrNoProgress)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func sendAndReadACK(ctx context.Context, port serialTransport, packet []byte, processingDelay time.Duration) error {
|
||||||
|
if err := writePacket(ctx, port, packet); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if err := waitForSequence(ctx, processingDelay); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
response := make([]byte, 3)
|
||||||
|
if err := readExact(ctx, port, response); err != nil {
|
||||||
|
return fmt.Errorf("read ACK: %w", err)
|
||||||
|
}
|
||||||
|
return checkACK(response)
|
||||||
|
}
|
||||||
|
|
||||||
|
// queryStatus accepts only the fixed RF/AP payload sizes, before reading a body.
|
||||||
|
func queryStatus(ctx context.Context, port serialTransport, command []byte, statusCount int, processingDelay time.Duration) ([]byte, error) {
|
||||||
|
if err := sendAndReadACK(ctx, port, createPacket(Address, command), processingDelay); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := writePacket(ctx, port, append([]byte{ENQ}, Address...)); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if err := waitForSequence(ctx, processingDelay); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
header := make([]byte, 5)
|
||||||
|
if err := readExact(ctx, port, header); err != nil {
|
||||||
|
return nil, fmt.Errorf("read status header: %w", err)
|
||||||
|
}
|
||||||
|
if header[0] != STX {
|
||||||
|
return nil, fmt.Errorf("invalid status STX: % X", header)
|
||||||
|
}
|
||||||
|
if len(Address) != 2 || header[1] != Address[0] || header[2] != Address[1] {
|
||||||
|
return nil, fmt.Errorf("unexpected status address: % X", header[1:3])
|
||||||
|
}
|
||||||
|
length := int(binary.BigEndian.Uint16(header[3:5]))
|
||||||
|
if length != statusCount+2 {
|
||||||
|
return nil, fmt.Errorf("invalid status payload length: got %d, want %d", length, statusCount+2)
|
||||||
|
}
|
||||||
|
frame := append(header, make([]byte, length+2)...)
|
||||||
|
if err := readExact(ctx, port, frame[5:]); err != nil {
|
||||||
|
return nil, fmt.Errorf("read status body: %w", err)
|
||||||
|
}
|
||||||
|
if frame[len(frame)-2] != ETX {
|
||||||
|
return nil, fmt.Errorf("invalid status ETX: % X", frame)
|
||||||
|
}
|
||||||
|
if calculateBCC(frame[:len(frame)-1]) != frame[len(frame)-1] {
|
||||||
|
return nil, fmt.Errorf("invalid status BCC: % X", frame)
|
||||||
|
}
|
||||||
|
if frame[5] != 'S' || frame[6] != 'F' {
|
||||||
|
return nil, fmt.Errorf("unexpected status response type: % X", frame[5:7])
|
||||||
|
}
|
||||||
|
return frame[7 : 7+statusCount], nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// --------------------
|
// --------------------
|
||||||
@@ -270,69 +390,31 @@ func InitializeDispenser() (*serial.Port, error) {
|
|||||||
// --------------------
|
// --------------------
|
||||||
|
|
||||||
// checkDispenserStatus talks to the device and returns the 4 status bytes [pos0..pos3].
|
// checkDispenserStatus talks to the device and returns the 4 status bytes [pos0..pos3].
|
||||||
func checkDispenserStatus(port *serial.Port) ([]byte, error) {
|
func checkDispenserStatus(ctx context.Context, port serialTransport) ([]byte, error) {
|
||||||
checkCmd := buildCheckAP(Address)
|
return queryStatus(ctx, port, []byte{0x02, 'A', 'P'}, 4, delay)
|
||||||
enq := append([]byte{ENQ}, Address...)
|
|
||||||
|
|
||||||
statusResp, err := sendAndReceive(port, checkCmd, delay)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("error sending check command: %w", err)
|
|
||||||
}
|
|
||||||
if len(statusResp) == 0 {
|
|
||||||
return nil, fmt.Errorf("no response from dispenser")
|
|
||||||
}
|
|
||||||
if err := checkACK(statusResp); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
statusResp, err = sendAndReceive(port, enq, delay)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("error sending ENQ: %w", err)
|
|
||||||
}
|
|
||||||
if len(statusResp) < 13 {
|
|
||||||
return nil, fmt.Errorf("incomplete status response from dispenser: % X", statusResp)
|
|
||||||
}
|
|
||||||
return statusResp[7:11], nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func cardToEncoderPosition(port *serial.Port) error {
|
// dispatchCommand confirms ACK and sends ENQ; it does not wait for movement.
|
||||||
enq := append([]byte{ENQ}, Address...)
|
func dispatchCommand(ctx context.Context, port serialTransport, command []byte, processingDelay time.Duration) error {
|
||||||
|
if err := sendAndReadACK(ctx, port, createPacket(Address, command), processingDelay); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return writePacket(ctx, port, append([]byte{ENQ}, Address...))
|
||||||
|
}
|
||||||
|
|
||||||
dispenseCmd := createPacket(Address, commandFC7)
|
func cardToEncoderPosition(ctx context.Context, port serialTransport) error {
|
||||||
log.Println("Send card to encoder position")
|
log.Println("Send card to encoder position")
|
||||||
|
return dispatchCommand(ctx, port, commandFC7, delay)
|
||||||
statusResp, err := sendAndReceive(port, dispenseCmd, delay)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("error sending card to encoder position: %w", err)
|
|
||||||
}
|
|
||||||
if err := checkACK(statusResp); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = port.Write(enq)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("error sending ENQ to prompt device: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func cardOutOfMouth(port *serial.Port) error {
|
func resetDispenser(ctx context.Context, port serialTransport) error {
|
||||||
enq := append([]byte{ENQ}, Address...)
|
return dispatchCommand(ctx, port, commandRS, delay)
|
||||||
|
}
|
||||||
|
|
||||||
dispenseCmd := createPacket(Address, commandFC0)
|
func cardOutOfMouth(ctx context.Context, port serialTransport) (bool, error) {
|
||||||
log.Println("Send card to out mouth position")
|
log.Println("Send card to out mouth position")
|
||||||
|
if err := sendAndReadACK(ctx, port, createPacket(Address, commandFC0), delay); err != nil {
|
||||||
statusResp, err := sendAndReceive(port, dispenseCmd, delay)
|
return false, err
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("error sending out of mouth command: %w", err)
|
|
||||||
}
|
}
|
||||||
if err := checkACK(statusResp); err != nil {
|
return writePacketAttempt(ctx, port, append([]byte{ENQ}, Address...))
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = port.Write(enq)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("error sending ENQ to prompt device: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ package dispenser
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
@@ -17,6 +18,8 @@ const (
|
|||||||
cmdStatus cmdType = iota
|
cmdStatus cmdType = iota
|
||||||
cmdToEncoder
|
cmdToEncoder
|
||||||
cmdOutOfMouth
|
cmdOutOfMouth
|
||||||
|
cmdReset
|
||||||
|
cmdDeliveryClearance
|
||||||
)
|
)
|
||||||
|
|
||||||
type cmdReq struct {
|
type cmdReq struct {
|
||||||
@@ -26,8 +29,9 @@ type cmdReq struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type cmdResp struct {
|
type cmdResp struct {
|
||||||
status []byte
|
deliveryPending bool
|
||||||
err error
|
status []byte
|
||||||
|
err error
|
||||||
}
|
}
|
||||||
|
|
||||||
type sequenceTiming struct {
|
type sequenceTiming struct {
|
||||||
@@ -36,17 +40,26 @@ type sequenceTiming struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const (
|
const (
|
||||||
sequencePollInterval = time.Second
|
sequencePollInterval = time.Second
|
||||||
sequenceRetryAfter = 6 * time.Second
|
sequenceShakeAfter = 3 * time.Second
|
||||||
sequenceTimeout = 12 * time.Second
|
sequenceResetWait = 2 * time.Second
|
||||||
|
sequenceTimeout = 32 * time.Second
|
||||||
|
sequenceUncertainWait = 4 * time.Second
|
||||||
|
sequenceMaxShakes = 3
|
||||||
|
deliveryClearanceTimeout = 6 * time.Second
|
||||||
|
deliveryMinimumWait = 2 * time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
type Client struct {
|
type Client struct {
|
||||||
port *serial.Port
|
port serialTransport
|
||||||
|
|
||||||
reqCh chan cmdReq
|
reqCh chan cmdReq
|
||||||
done chan struct{}
|
done chan struct{}
|
||||||
|
|
||||||
|
// Owned exclusively by the serial worker.
|
||||||
|
deliveryPending bool
|
||||||
|
deliveryStarted time.Time
|
||||||
|
|
||||||
sequenceTiming sequenceTiming
|
sequenceTiming sequenceTiming
|
||||||
|
|
||||||
// status cache
|
// status cache
|
||||||
@@ -187,24 +200,41 @@ func (c *Client) handle(req cmdReq) {
|
|||||||
|
|
||||||
switch req.typ {
|
switch req.typ {
|
||||||
case cmdStatus:
|
case cmdStatus:
|
||||||
st, err := checkDispenserStatus(c.port)
|
st, err := c.readWorkerStatus(req.ctx)
|
||||||
if err == nil && len(st) == 4 {
|
req.respCh <- cmdResp{status: st, err: err, deliveryPending: c.deliveryPending}
|
||||||
c.mu.Lock()
|
|
||||||
c.lastStatus = append([]byte(nil), st...)
|
|
||||||
c.lastStatusT = time.Now()
|
|
||||||
c.mu.Unlock()
|
|
||||||
|
|
||||||
// publish stock/cardwell
|
case cmdDeliveryClearance:
|
||||||
c.setStock(st)
|
st, err := c.waitWorkerDeliveryClearance(req.ctx)
|
||||||
}
|
req.respCh <- cmdResp{status: st, err: err, deliveryPending: c.deliveryPending}
|
||||||
req.respCh <- cmdResp{status: st, err: err}
|
|
||||||
|
|
||||||
case cmdToEncoder:
|
case cmdToEncoder:
|
||||||
err := cardToEncoderPosition(c.port)
|
if c.deliveryPending {
|
||||||
|
if _, err := c.waitWorkerDeliveryClearance(req.ctx); err != nil {
|
||||||
|
req.respCh <- cmdResp{err: err}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
err := cardToEncoderPosition(req.ctx, c.port)
|
||||||
|
log.Infof("FC7 dispatch finished; dispatched=%t error=%v", err == nil, err)
|
||||||
|
c.invalidateStatusCache()
|
||||||
|
req.respCh <- cmdResp{err: err}
|
||||||
|
|
||||||
|
case cmdReset:
|
||||||
|
err := resetDispenser(req.ctx, c.port)
|
||||||
|
log.Infof("RS dispatch finished; dispatched=%t error=%v", err == nil, err)
|
||||||
|
c.invalidateStatusCache()
|
||||||
req.respCh <- cmdResp{err: err}
|
req.respCh <- cmdResp{err: err}
|
||||||
|
|
||||||
case cmdOutOfMouth:
|
case cmdOutOfMouth:
|
||||||
err := cardOutOfMouth(c.port)
|
attempted, err := cardOutOfMouth(req.ctx, c.port)
|
||||||
|
log.Infof("FC0 dispatch finished; ENQ_attempted=%t error=%v", attempted, err)
|
||||||
|
if attempted {
|
||||||
|
c.deliveryPending = true
|
||||||
|
c.deliveryStarted = c.now()
|
||||||
|
log.Info("delivery ENQ attempted; awaiting mechanical clearance")
|
||||||
|
}
|
||||||
|
// A movement command makes any previously cached position unreliable.
|
||||||
|
c.invalidateStatusCache()
|
||||||
req.respCh <- cmdResp{err: err}
|
req.respCh <- cmdResp{err: err}
|
||||||
|
|
||||||
default:
|
default:
|
||||||
@@ -212,21 +242,78 @@ func (c *Client) handle(req cmdReq) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// deliveryClearance deliberately does not apply encoder-success precedence.
|
||||||
|
func deliveryClearance(status []byte) (bool, error) {
|
||||||
|
class, err := classifyPreparationStatus(status)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
if class == positionWellEmpty {
|
||||||
|
return false, ErrCardWellEmpty
|
||||||
|
}
|
||||||
|
if isPreparationMoving(status) || status[1] == 0x34 {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
return status[3] == 0x30 || status[3] == 0x34, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) now() time.Time {
|
||||||
|
if c.sequenceTiming.now != nil {
|
||||||
|
return c.sequenceTiming.now()
|
||||||
|
}
|
||||||
|
return time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
// readWorkerStatus is called only by the serial worker and always reads fresh AP.
|
||||||
|
func (c *Client) readWorkerStatus(ctx context.Context) ([]byte, error) {
|
||||||
|
st, err := checkDispenserStatus(ctx, c.port)
|
||||||
|
if err != nil {
|
||||||
|
return st, err
|
||||||
|
}
|
||||||
|
if err := ctx.Err(); err != nil {
|
||||||
|
return st, err
|
||||||
|
}
|
||||||
|
if c.deliveryPending {
|
||||||
|
class, _ := classifyPreparationStatus(st)
|
||||||
|
log.Infof("delivery clearance AP; class=%s elapsed=%s raw status: % X", class, c.now().Sub(c.deliveryStarted), st)
|
||||||
|
clear, clearanceErr := deliveryClearance(st)
|
||||||
|
if clearanceErr != nil {
|
||||||
|
log.Warnf("delivery clearance failed: %v; %s raw status: % X", clearanceErr, statusDescription(st), st)
|
||||||
|
} else if clear && c.now().Sub(c.deliveryStarted) >= deliveryMinimumWait {
|
||||||
|
c.deliveryPending = false
|
||||||
|
log.Infof("previous delivery cleared after %s; FC7 permitted", c.now().Sub(c.deliveryStarted))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(st) == 4 {
|
||||||
|
c.mu.Lock()
|
||||||
|
c.lastStatus = append([]byte(nil), st...)
|
||||||
|
c.lastStatusT = time.Now()
|
||||||
|
c.mu.Unlock()
|
||||||
|
c.setStock(st)
|
||||||
|
}
|
||||||
|
return st, nil
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Client) do(ctx context.Context, typ cmdType) ([]byte, error) {
|
func (c *Client) do(ctx context.Context, typ cmdType) ([]byte, error) {
|
||||||
|
r := c.doResponse(ctx, typ)
|
||||||
|
return r.status, r.err
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) doResponse(ctx context.Context, typ cmdType) cmdResp {
|
||||||
rch := make(chan cmdResp, 1)
|
rch := make(chan cmdResp, 1)
|
||||||
req := cmdReq{typ: typ, ctx: ctx, respCh: rch}
|
req := cmdReq{typ: typ, ctx: ctx, respCh: rch}
|
||||||
|
|
||||||
select {
|
select {
|
||||||
case c.reqCh <- req:
|
case c.reqCh <- req:
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return nil, ctx.Err()
|
return cmdResp{err: ctx.Err()}
|
||||||
}
|
}
|
||||||
|
|
||||||
select {
|
select {
|
||||||
case r := <-rch:
|
case r := <-rch:
|
||||||
return r.status, r.err
|
return r
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return nil, ctx.Err()
|
return cmdResp{err: ctx.Err()}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -246,11 +333,24 @@ func (c *Client) CheckStatus(ctx context.Context) ([]byte, error) {
|
|||||||
return c.do(ctx, cmdStatus)
|
return c.do(ctx, cmdStatus)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (c *Client) invalidateStatusCache() {
|
||||||
|
c.mu.Lock()
|
||||||
|
c.lastStatus = nil
|
||||||
|
c.lastStatusT = time.Time{}
|
||||||
|
c.mu.Unlock()
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Client) ToEncoder(ctx context.Context) error {
|
func (c *Client) ToEncoder(ctx context.Context) error {
|
||||||
_, err := c.do(ctx, cmdToEncoder)
|
_, err := c.do(ctx, cmdToEncoder)
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Reset dispatches RS through the port owner; acceptance does not imply mechanical completion.
|
||||||
|
func (c *Client) Reset(ctx context.Context) error {
|
||||||
|
_, err := c.do(ctx, cmdReset)
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Client) OutOfMouth(ctx context.Context) error {
|
func (c *Client) OutOfMouth(ctx context.Context) error {
|
||||||
_, err := c.do(ctx, cmdOutOfMouth)
|
_, err := c.do(ctx, cmdOutOfMouth)
|
||||||
return err
|
return err
|
||||||
@@ -298,13 +398,14 @@ func (c *Client) DispenserPrepare(ctx context.Context) (string, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) readSequenceStatus(ctx context.Context, operation string) ([]byte, string, error) {
|
func (c *Client) readSequenceStatus(ctx context.Context, operation string) ([]byte, string, error) {
|
||||||
status, err := c.do(ctx, cmdStatus)
|
response := c.doResponse(ctx, cmdStatus)
|
||||||
if err != nil {
|
if err := ctx.Err(); err != nil {
|
||||||
if ctxErr := ctx.Err(); ctxErr != nil {
|
return nil, "", err
|
||||||
return nil, "", fmt.Errorf("[%s] read status: %w", operation, ctxErr)
|
|
||||||
}
|
|
||||||
return nil, "", fmt.Errorf("[%s] read status: %w", operation, err)
|
|
||||||
}
|
}
|
||||||
|
if response.deliveryPending {
|
||||||
|
return c.waitForDeliveryClearance(ctx, operation)
|
||||||
|
}
|
||||||
|
status := usableObservation(response.status, response.err, operation)
|
||||||
|
|
||||||
stockStatus := ""
|
stockStatus := ""
|
||||||
if len(status) == 4 {
|
if len(status) == 4 {
|
||||||
@@ -315,111 +416,236 @@ func (c *Client) readSequenceStatus(ctx context.Context, operation string) ([]by
|
|||||||
return status, stockStatus, nil
|
return status, stockStatus, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func preparationStatus(operation string, status []byte) (bool, error) {
|
// waitWorkerDeliveryClearance runs only inside the serial worker.
|
||||||
if len(status) != 4 {
|
// An unusable observation never becomes a fabricated physical position.
|
||||||
return false, fmt.Errorf("[%s] %w", operation, validateDispenserStatusData(status))
|
func (c *Client) waitWorkerDeliveryClearance(parent context.Context) ([]byte, error) {
|
||||||
}
|
ctx, cancel := context.WithTimeout(parent, deliveryClearanceTimeout)
|
||||||
if isAtEncoderPosition(status) {
|
defer cancel()
|
||||||
if hasPreparationDiagnostics(status) {
|
deadline := c.now().Add(deliveryClearanceTimeout)
|
||||||
log.Warnf(
|
var latest []byte
|
||||||
"[%s] card confirmed at encoder with dispenser diagnostics: %s raw status: % X",
|
|
||||||
operation,
|
|
||||||
statusDescription(status),
|
|
||||||
status,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
if err := validateDispenserStatusData(status); err != nil {
|
|
||||||
return false, fmt.Errorf("[%s] %w", operation, err)
|
|
||||||
}
|
|
||||||
if isCardWellEmpty(status) {
|
|
||||||
return false, fmt.Errorf("[%s] %w", operation, ErrCardWellEmpty)
|
|
||||||
}
|
|
||||||
if isPreparationMoving(status) {
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
if err := dispenserStatusError(status); err != nil {
|
|
||||||
return false, fmt.Errorf("[%s] %w", operation, err)
|
|
||||||
}
|
|
||||||
return false, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Client) pollForEncoderPosition(
|
|
||||||
ctx context.Context,
|
|
||||||
operation string,
|
|
||||||
retryCommand func(context.Context) error,
|
|
||||||
) (string, error) {
|
|
||||||
started := c.sequenceTiming.now()
|
|
||||||
halfway := started.Add(sequenceRetryAfter)
|
|
||||||
deadline := started.Add(sequenceTimeout)
|
|
||||||
retried := false
|
|
||||||
stockStatus := ""
|
|
||||||
|
|
||||||
for {
|
for {
|
||||||
if err := ctx.Err(); err != nil {
|
if err := parent.Err(); err != nil {
|
||||||
return stockStatus, fmt.Errorf("[%s] %w", operation, err)
|
return nil, err
|
||||||
}
|
}
|
||||||
|
if !c.now().Before(deadline) || ctx.Err() != nil {
|
||||||
now := c.sequenceTiming.now()
|
class, err := classifyPreparationStatus(latest)
|
||||||
if !now.Before(deadline) {
|
if err == nil && class == positionWellEmpty {
|
||||||
return stockStatus, fmt.Errorf("[%s] timed out after %s", operation, sequenceTimeout)
|
return latest, ErrCardWellEmpty
|
||||||
}
|
|
||||||
|
|
||||||
status, currentStockStatus, err := c.readSequenceStatus(ctx, operation)
|
|
||||||
stockStatus = currentStockStatus
|
|
||||||
if err != nil {
|
|
||||||
return stockStatus, err
|
|
||||||
}
|
|
||||||
ready, err := preparationStatus(operation, status)
|
|
||||||
if err != nil {
|
|
||||||
return stockStatus, err
|
|
||||||
}
|
|
||||||
if ready {
|
|
||||||
return stockStatus, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
now = c.sequenceTiming.now()
|
|
||||||
if !now.Before(deadline) {
|
|
||||||
return stockStatus, fmt.Errorf("[%s] timed out after %s", operation, sequenceTimeout)
|
|
||||||
}
|
|
||||||
if retryCommand != nil && !retried && !now.Before(halfway) {
|
|
||||||
if err := retryCommand(ctx); err != nil {
|
|
||||||
return stockStatus, fmt.Errorf("[%s] retry command: %w", operation, err)
|
|
||||||
}
|
}
|
||||||
retried = true
|
if err == nil && (isPreparationMoving(latest) || latest[1] == 0x34) {
|
||||||
|
return latest, context.DeadlineExceeded
|
||||||
|
}
|
||||||
|
c.deliveryPending = false
|
||||||
|
log.Warn("delivery clearance assumed after bounded observation fallback")
|
||||||
|
return latest, nil
|
||||||
|
}
|
||||||
|
st, err := c.readWorkerStatus(ctx)
|
||||||
|
if parent.Err() != nil {
|
||||||
|
return nil, parent.Err()
|
||||||
|
}
|
||||||
|
latest = usableObservation(st, err, "delivery clearance")
|
||||||
|
if latest != nil && latest[3] == 0x38 {
|
||||||
|
return latest, ErrCardWellEmpty
|
||||||
|
}
|
||||||
|
if !c.deliveryPending {
|
||||||
|
return latest, nil
|
||||||
|
}
|
||||||
|
remaining := deadline.Sub(c.now())
|
||||||
|
if remaining <= 0 || ctx.Err() != nil {
|
||||||
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
wait := sequencePollInterval
|
wait := sequencePollInterval
|
||||||
if remaining := deadline.Sub(now); remaining < wait {
|
if remaining < wait {
|
||||||
wait = remaining
|
wait = remaining
|
||||||
}
|
}
|
||||||
if err := c.sequenceTiming.wait(ctx, wait); err != nil {
|
if err := c.sequenceTiming.wait(ctx, wait); err != nil && parent.Err() != nil {
|
||||||
return stockStatus, fmt.Errorf("[%s] %w", operation, err)
|
return nil, parent.Err()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *Client) prepareCardAtEncoder(ctx context.Context, operation string) (string, error) {
|
// usableObservation preserves strict validation while discarding unusable telemetry.
|
||||||
status, stockStatus, err := c.readSequenceStatus(ctx, operation)
|
func usableObservation(status []byte, err error, operation string) []byte {
|
||||||
|
if err == nil {
|
||||||
|
_, err = classifyPreparationStatus(status)
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return stockStatus, err
|
log.Warnf("[%s] unusable AP observation; raw status: % X error=%v", operation, status, err)
|
||||||
|
return nil
|
||||||
}
|
}
|
||||||
ready, err := preparationStatus(operation, status)
|
return status
|
||||||
if err != nil {
|
|
||||||
return stockStatus, err
|
|
||||||
}
|
|
||||||
if ready {
|
|
||||||
return stockStatus, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := c.ToEncoder(ctx); err != nil {
|
|
||||||
return stockStatus, fmt.Errorf("[%s] to encoder: %w", operation, err)
|
|
||||||
}
|
|
||||||
return c.pollForEncoderPosition(ctx, operation, c.ToEncoder)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// PrepareCurrentCard authoritatively places the card to be encoded at the encoder.
|
// waitForDeliveryClearance uses a worker request; no worker recursively enqueues.
|
||||||
|
func (c *Client) waitForDeliveryClearance(ctx context.Context, operation string) ([]byte, string, error) {
|
||||||
|
r := c.doResponse(ctx, cmdDeliveryClearance)
|
||||||
|
stock := ""
|
||||||
|
if len(r.status) == 4 {
|
||||||
|
stock = stockTake(r.status)
|
||||||
|
}
|
||||||
|
if r.err != nil {
|
||||||
|
return nil, stock, fmt.Errorf("[%s] delivery clearance: %w", operation, r.err)
|
||||||
|
}
|
||||||
|
return r.status, stock, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *Client) prepareCardAtEncoder(parent context.Context, operation string) (stock string, resultErr error) {
|
||||||
|
status, stock, err := c.waitForDeliveryClearance(parent, operation)
|
||||||
|
if err != nil {
|
||||||
|
return stock, err
|
||||||
|
}
|
||||||
|
status = usableObservation(status, nil, operation)
|
||||||
|
started := c.now()
|
||||||
|
deadline := started.Add(sequenceTimeout)
|
||||||
|
ctx, cancel := context.WithTimeoutCause(parent, sequenceTimeout, ErrPreparationExhausted)
|
||||||
|
defer cancel()
|
||||||
|
shakes := 0
|
||||||
|
stage := "initial status"
|
||||||
|
var lastFC7, uncertainSince time.Time
|
||||||
|
var previous preparationClass
|
||||||
|
defer func() {
|
||||||
|
log.Infof("[%s] preparation finished; stage=%s shakes=%d elapsed=%s raw status: % X error=%v", operation, stage, shakes, c.now().Sub(started), status, resultErr)
|
||||||
|
}()
|
||||||
|
checkDeadline := func() error {
|
||||||
|
if err := parent.Err(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if !c.now().Before(deadline) || errors.Is(context.Cause(ctx), ErrPreparationExhausted) {
|
||||||
|
return ErrPreparationExhausted
|
||||||
|
}
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
// Only observation exhaustion can grant a deadline handoff. Command and
|
||||||
|
// reset-settle failures never pass through this policy.
|
||||||
|
observationResult := func(err error) error {
|
||||||
|
if parent.Err() != nil {
|
||||||
|
return parent.Err()
|
||||||
|
}
|
||||||
|
if !errors.Is(err, ErrPreparationExhausted) || lastFC7.IsZero() {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
class, _ := classifyPreparationStatus(status)
|
||||||
|
switch class {
|
||||||
|
case positionWellEmpty:
|
||||||
|
return ErrCardWellEmpty
|
||||||
|
case positionNoCard:
|
||||||
|
return err
|
||||||
|
default:
|
||||||
|
stage = "observation deadline encoder handoff"
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
wait := func(duration time.Duration) error {
|
||||||
|
if err := checkDeadline(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if remaining := deadline.Sub(c.now()); remaining < duration {
|
||||||
|
duration = remaining
|
||||||
|
}
|
||||||
|
if err := c.sequenceTiming.wait(ctx, duration); err != nil {
|
||||||
|
if deadlineErr := checkDeadline(); deadlineErr != nil {
|
||||||
|
return deadlineErr
|
||||||
|
}
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return checkDeadline()
|
||||||
|
}
|
||||||
|
sendFC7 := func() error {
|
||||||
|
stage = "FC7 dispatch"
|
||||||
|
if err := checkDeadline(); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
err := c.ToEncoder(ctx)
|
||||||
|
if deadlineErr := checkDeadline(); deadlineErr != nil {
|
||||||
|
return deadlineErr
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("[%s] FC7 dispatch: %w", operation, err)
|
||||||
|
}
|
||||||
|
lastFC7 = c.now()
|
||||||
|
log.Infof("[%s] FC7 dispatched; shake=%d elapsed=%s", operation, shakes, lastFC7.Sub(started))
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
if err := checkDeadline(); err != nil {
|
||||||
|
return stock, observationResult(err)
|
||||||
|
}
|
||||||
|
class, _ := classifyPreparationStatus(status)
|
||||||
|
// No class means unusable telemetry, sharing the uncertainty timer.
|
||||||
|
|
||||||
|
log.Infof("[%s] fresh AP; class=%s previous=%s elapsed=%s shake=%d raw status: % X", operation, class, previous, c.now().Sub(started), shakes, status)
|
||||||
|
previous = class
|
||||||
|
switch class {
|
||||||
|
case encoderConfirmed:
|
||||||
|
stage = "encoder sensor handoff"
|
||||||
|
return stock, observationResult(checkDeadline())
|
||||||
|
case positionWellEmpty:
|
||||||
|
stage = "empty"
|
||||||
|
return stock, ErrCardWellEmpty
|
||||||
|
}
|
||||||
|
if lastFC7.IsZero() {
|
||||||
|
if err := sendFC7(); err != nil {
|
||||||
|
return stock, err
|
||||||
|
}
|
||||||
|
} else if class == positionNoCard && c.now().Sub(lastFC7) >= sequenceShakeAfter {
|
||||||
|
uncertainSince = time.Time{}
|
||||||
|
if shakes == sequenceMaxShakes {
|
||||||
|
stage = "three shakes exhausted"
|
||||||
|
return stock, ErrPreparationExhausted
|
||||||
|
}
|
||||||
|
shakes++
|
||||||
|
stage = "RS dispatch"
|
||||||
|
if err := checkDeadline(); err != nil {
|
||||||
|
return stock, err
|
||||||
|
}
|
||||||
|
err := c.Reset(ctx)
|
||||||
|
if deadlineErr := checkDeadline(); deadlineErr != nil {
|
||||||
|
return stock, deadlineErr
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return stock, fmt.Errorf("[%s] RS dispatch: %w", operation, err)
|
||||||
|
}
|
||||||
|
stage = "reset settling"
|
||||||
|
log.Infof("[%s] RS dispatched; shake=%d settling=%s", operation, shakes, sequenceResetWait)
|
||||||
|
if err := wait(sequenceResetWait); err != nil {
|
||||||
|
return stock, err
|
||||||
|
}
|
||||||
|
log.Infof("[%s] reset settle wait completed; shake=%d", operation, shakes)
|
||||||
|
if err := sendFC7(); err != nil {
|
||||||
|
return stock, err
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if class == positionUncertain || class == "" {
|
||||||
|
if uncertainSince.IsZero() {
|
||||||
|
uncertainSince = c.now()
|
||||||
|
}
|
||||||
|
if c.now().Sub(uncertainSince) >= sequenceUncertainWait {
|
||||||
|
stage = "uncertain position handoff"
|
||||||
|
return stock, observationResult(checkDeadline())
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
uncertainSince = time.Time{}
|
||||||
|
}
|
||||||
|
stage = "polling"
|
||||||
|
if err := wait(sequencePollInterval); err != nil {
|
||||||
|
return stock, observationResult(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
stage = "fresh AP"
|
||||||
|
if err := checkDeadline(); err != nil {
|
||||||
|
return stock, observationResult(err)
|
||||||
|
}
|
||||||
|
status, stock, err = c.readSequenceStatus(ctx, operation)
|
||||||
|
if deadlineErr := checkDeadline(); deadlineErr != nil {
|
||||||
|
return stock, observationResult(deadlineErr)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return stock, err
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// PrepareCurrentCard grants one encoder opportunity after bounded physical preparation.
|
||||||
func (c *Client) PrepareCurrentCard(ctx context.Context) (string, error) {
|
func (c *Client) PrepareCurrentCard(ctx context.Context) (string, error) {
|
||||||
return c.prepareCardAtEncoder(ctx, "PrepareCurrentCard")
|
return c.prepareCardAtEncoder(ctx, "PrepareCurrentCard")
|
||||||
}
|
}
|
||||||
@@ -434,7 +660,8 @@ func (c *Client) DeliverCurrentCard(ctx context.Context) (string, error) {
|
|||||||
return "", nil
|
return "", nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// BeginPrepareNextCard starts moving the next card to the encoder without waiting for readiness.
|
// BeginPrepareNextCard waits for worker-owned clearance and dispatches one FC7.
|
||||||
|
// It does not wait for encoder readiness.
|
||||||
func (c *Client) BeginPrepareNextCard(ctx context.Context) error {
|
func (c *Client) BeginPrepareNextCard(ctx context.Context) error {
|
||||||
if err := c.ToEncoder(ctx); err != nil {
|
if err := c.ToEncoder(ctx); err != nil {
|
||||||
return fmt.Errorf("[BeginPrepareNextCard] to encoder: %w", err)
|
return fmt.Errorf("[BeginPrepareNextCard] to encoder: %w", err)
|
||||||
@@ -442,7 +669,7 @@ func (c *Client) BeginPrepareNextCard(ctx context.Context) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// PrepareNextCard places a new card at the encoder for a later issuance attempt.
|
// PrepareNextCard runs the same bounded physical preparation for a later issuance attempt.
|
||||||
func (c *Client) PrepareNextCard(ctx context.Context) (string, error) {
|
func (c *Client) PrepareNextCard(ctx context.Context) (string, error) {
|
||||||
return c.prepareCardAtEncoder(ctx, "PrepareNextCard")
|
return c.prepareCardAtEncoder(ctx, "PrepareNextCard")
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -4,17 +4,19 @@ import (
|
|||||||
"bytes"
|
"bytes"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"reflect"
|
||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
log "github.com/sirupsen/logrus"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type fakeSequenceDevice struct {
|
type fakeSequenceDevice struct {
|
||||||
statusResponses []cmdResp
|
statusResponses []cmdResp
|
||||||
commandErrors map[cmdType][]error
|
commandErrors map[cmdType][]error
|
||||||
commands []cmdType
|
commands []cmdType
|
||||||
|
commandTimes []time.Time
|
||||||
|
onCommand func(cmdType)
|
||||||
}
|
}
|
||||||
|
|
||||||
func newSequenceTestClient(t *testing.T, statusResponses ...cmdResp) (*Client, *fakeSequenceDevice) {
|
func newSequenceTestClient(t *testing.T, statusResponses ...cmdResp) (*Client, *fakeSequenceDevice) {
|
||||||
@@ -50,13 +52,25 @@ func newSequenceTestClient(t *testing.T, statusResponses ...cmdResp) (*Client, *
|
|||||||
case <-client.done:
|
case <-client.done:
|
||||||
return
|
return
|
||||||
case request := <-client.reqCh:
|
case request := <-client.reqCh:
|
||||||
|
clearance := request.typ == cmdDeliveryClearance
|
||||||
|
if clearance {
|
||||||
|
request.typ = cmdStatus
|
||||||
|
}
|
||||||
device.commands = append(device.commands, request.typ)
|
device.commands = append(device.commands, request.typ)
|
||||||
|
device.commandTimes = append(device.commandTimes, now)
|
||||||
|
if device.onCommand != nil {
|
||||||
|
device.onCommand(request.typ)
|
||||||
|
}
|
||||||
if request.typ == cmdStatus {
|
if request.typ == cmdStatus {
|
||||||
if len(device.statusResponses) == 0 {
|
if len(device.statusResponses) == 0 {
|
||||||
request.respCh <- cmdResp{err: errors.New("unexpected status read")}
|
request.respCh <- cmdResp{err: errors.New("unexpected status read")}
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
response := device.statusResponses[0]
|
response := device.statusResponses[0]
|
||||||
|
if clearance && request.ctx.Err() == nil {
|
||||||
|
response.status = usableObservation(response.status, response.err, "fake clearance")
|
||||||
|
response.err = nil
|
||||||
|
}
|
||||||
device.statusResponses = device.statusResponses[1:]
|
device.statusResponses = device.statusResponses[1:]
|
||||||
request.respCh <- response
|
request.respCh <- response
|
||||||
continue
|
continue
|
||||||
@@ -90,142 +104,11 @@ func commandCount(commands []cmdType, target cmdType) int {
|
|||||||
return count
|
return count
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPrepareCurrentCardAcceptsEncoderPositionWithStaleDiagnostics(t *testing.T) {
|
func TestResetPacket(t *testing.T) {
|
||||||
tests := []struct {
|
got := createPacket([]byte{0x30, 0x30}, commandRS)
|
||||||
name string
|
want := []byte{0x02, 0x30, 0x30, 0x00, 0x02, 0x52, 0x53, 0x03, 0x02}
|
||||||
status []byte
|
if !bytes.Equal(got, want) {
|
||||||
wantStock string
|
t.Errorf("createPacket(RS) = % X, want % X", got, want)
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "dispense error and jam",
|
|
||||||
status: []byte{0x30, 0x32, 0x32, 0x33},
|
|
||||||
wantStock: "Card jammed",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "supply diagnostics",
|
|
||||||
status: []byte{0x32, 0x30, 0x31, 0x33},
|
|
||||||
wantStock: "Card pre-empty",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "combined stale jam and supply diagnostics",
|
|
||||||
status: []byte{0x30, 0x32, 0x33, 0x33},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
var logOutput bytes.Buffer
|
|
||||||
standardLogger := log.StandardLogger()
|
|
||||||
previousOutput := standardLogger.Out
|
|
||||||
standardLogger.SetOutput(&logOutput)
|
|
||||||
t.Cleanup(func() {
|
|
||||||
standardLogger.SetOutput(previousOutput)
|
|
||||||
})
|
|
||||||
|
|
||||||
client, device := newSequenceTestClient(t, cmdResp{status: test.status})
|
|
||||||
|
|
||||||
stock, err := client.PrepareCurrentCard(context.Background())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if stock != test.wantStock {
|
|
||||||
t.Fatalf("stock status = %q, want %q", stock, test.wantStock)
|
|
||||||
}
|
|
||||||
if got := commandCount(device.commands, cmdToEncoder); got != 0 {
|
|
||||||
t.Fatalf("to-encoder commands = %d, want 0", got)
|
|
||||||
}
|
|
||||||
if got := commandCount(device.commands, cmdStatus); got != 1 {
|
|
||||||
t.Fatalf("status reads = %d, want 1", got)
|
|
||||||
}
|
|
||||||
logged := logOutput.String()
|
|
||||||
if !strings.Contains(logged, "card confirmed at encoder") ||
|
|
||||||
!strings.Contains(logged, statusDescription(test.status)) ||
|
|
||||||
!strings.Contains(logged, "raw status") {
|
|
||||||
t.Fatalf("encoder diagnostic log = %q", logged)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPrepareCurrentCardPollingAllowsTransientMovementWithStaleErrors(t *testing.T) {
|
|
||||||
client, device := newSequenceTestClient(t,
|
|
||||||
cmdResp{status: status(0x34)},
|
|
||||||
cmdResp{status: []byte{0x31, 0x38, 0x32, 0x30}},
|
|
||||||
cmdResp{status: []byte{0x30, 0x32, 0x32, 0x33}},
|
|
||||||
)
|
|
||||||
|
|
||||||
stock, err := client.PrepareCurrentCard(context.Background())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if stock != "Card jammed" {
|
|
||||||
t.Fatalf("stock status = %q, want Card jammed", stock)
|
|
||||||
}
|
|
||||||
if got := commandCount(device.commands, cmdToEncoder); got != 1 {
|
|
||||||
t.Fatalf("to-encoder commands = %d, want 1", got)
|
|
||||||
}
|
|
||||||
if got := commandCount(device.commands, cmdStatus); got != 3 {
|
|
||||||
t.Fatalf("status reads = %d, want 3", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPrepareCurrentCardRejectsFailureWithoutEncoderOrMovement(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
response cmdResp
|
|
||||||
wantError string
|
|
||||||
wantStock string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "status read error",
|
|
||||||
response: cmdResp{err: errors.New("serial read failed")},
|
|
||||||
wantError: "serial read failed",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "malformed status",
|
|
||||||
response: cmdResp{status: []byte{0x30, 0x30, 0x31}},
|
|
||||||
wantError: "malformed dispenser status",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "unknown status",
|
|
||||||
response: cmdResp{status: []byte{0x30, 0x30, 0x30, 0x39}},
|
|
||||||
wantError: "unknown dispenser status",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "jammed preparation",
|
|
||||||
response: cmdResp{status: []byte{0x30, 0x30, 0x32, 0x34}},
|
|
||||||
wantError: "Card jammed",
|
|
||||||
wantStock: "Card jammed",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, test := range tests {
|
|
||||||
t.Run(test.name, func(t *testing.T) {
|
|
||||||
client, _ := newSequenceTestClient(t, test.response)
|
|
||||||
|
|
||||||
stock, err := client.PrepareCurrentCard(context.Background())
|
|
||||||
if err == nil || !strings.Contains(err.Error(), test.wantError) {
|
|
||||||
t.Fatalf("error = %v, want containing %q", err, test.wantError)
|
|
||||||
}
|
|
||||||
if stock != test.wantStock {
|
|
||||||
t.Fatalf("stock status = %q, want %q", stock, test.wantStock)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPrepareCurrentCardReturnsAuthoritativeEmptyWellError(t *testing.T) {
|
|
||||||
client, device := newSequenceTestClient(t, cmdResp{status: status(0x38)})
|
|
||||||
|
|
||||||
stock, err := client.PrepareCurrentCard(context.Background())
|
|
||||||
if !errors.Is(err, ErrCardWellEmpty) {
|
|
||||||
t.Fatalf("error = %v, want ErrCardWellEmpty", err)
|
|
||||||
}
|
|
||||||
if stock != "Card empty" {
|
|
||||||
t.Fatalf("stock status = %q, want Card empty", stock)
|
|
||||||
}
|
|
||||||
if got := commandCount(device.commands, cmdToEncoder); got != 0 {
|
|
||||||
t.Fatalf("to-encoder commands = %d, want 0", got)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -291,42 +174,6 @@ func TestDeliverCurrentCardPreservesContextCancellation(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPrepareCurrentCardRetriesOnceThenTimesOut(t *testing.T) {
|
|
||||||
responses := make([]cmdResp, 13)
|
|
||||||
for index := range responses {
|
|
||||||
responses[index] = cmdResp{status: status(0x34)}
|
|
||||||
}
|
|
||||||
client, device := newSequenceTestClient(t, responses...)
|
|
||||||
|
|
||||||
_, err := client.PrepareCurrentCard(context.Background())
|
|
||||||
if err == nil || !strings.Contains(err.Error(), "timed out") {
|
|
||||||
t.Fatalf("error = %v, want preparation timeout", err)
|
|
||||||
}
|
|
||||||
if got := commandCount(device.commands, cmdToEncoder); got != 2 {
|
|
||||||
t.Fatalf("to-encoder commands = %d, want initial command plus one halfway retry", got)
|
|
||||||
}
|
|
||||||
if got := commandCount(device.commands, cmdStatus); got != 13 {
|
|
||||||
t.Fatalf("status reads = %d, want 13", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPrepareCurrentCardPropagatesContextCancellation(t *testing.T) {
|
|
||||||
client, _ := newSequenceTestClient(t,
|
|
||||||
cmdResp{status: status(0x34)},
|
|
||||||
cmdResp{status: status(0x34)},
|
|
||||||
)
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
client.sequenceTiming.wait = func(context.Context, time.Duration) error {
|
|
||||||
cancel()
|
|
||||||
return ctx.Err()
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := client.PrepareCurrentCard(ctx)
|
|
||||||
if !errors.Is(err, context.Canceled) {
|
|
||||||
t.Fatalf("error = %v, want context.Canceled", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestBeginPrepareNextCardDispatchesWithoutReadinessPolling(t *testing.T) {
|
func TestBeginPrepareNextCardDispatchesWithoutReadinessPolling(t *testing.T) {
|
||||||
client, device := newSequenceTestClient(t)
|
client, device := newSequenceTestClient(t)
|
||||||
|
|
||||||
@@ -357,48 +204,292 @@ func TestBeginPrepareNextCardReturnsDispatchFailureWithoutPolling(t *testing.T)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestPrepareCardAtEncoderRequiresConfirmedEncoderState(t *testing.T) {
|
func TestPositionDescriptions(t *testing.T) {
|
||||||
tests := []struct {
|
for _, test := range []struct {
|
||||||
name string
|
position byte
|
||||||
responses []cmdResp
|
want string
|
||||||
wantError string
|
|
||||||
wantToEncoder int
|
|
||||||
}{
|
}{
|
||||||
{
|
{0x30, ""},
|
||||||
name: "already at encoder",
|
{0x31, "Card at pre-dispense position; "},
|
||||||
responses: []cmdResp{{status: status(0x33)}},
|
{0x32, "Card at encoder position; "},
|
||||||
wantToEncoder: 0,
|
{0x34, "Card at mouth position; "},
|
||||||
},
|
{0x37, "Card at pre-dispense position; Card at encoder position; Card at mouth position; "},
|
||||||
{
|
{0x39, "Card at pre-dispense position; Card empty; "},
|
||||||
name: "moves ready card to encoder",
|
{0x3F, "Card at pre-dispense position; Card at encoder position; Card at mouth position; Card empty; "},
|
||||||
responses: []cmdResp{
|
{0x40, "Unknown status 0x40 at position 4; "},
|
||||||
{status: status(0x34)},
|
} {
|
||||||
{status: status(0x33)},
|
if got := statusDescription(status(test.position)); got != test.want {
|
||||||
},
|
t.Errorf("statusDescription(position %X) = %q, want %q", test.position, got, test.want)
|
||||||
wantToEncoder: 1,
|
}
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "empty card well",
|
|
||||||
responses: []cmdResp{{status: status(0x38)}},
|
|
||||||
wantError: CardWellEmptyMessage,
|
|
||||||
wantToEncoder: 0,
|
|
||||||
},
|
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
|
||||||
for _, test := range tests {
|
func positionResponses(position byte, count int) []cmdResp {
|
||||||
t.Run(test.name, func(t *testing.T) {
|
responses := make([]cmdResp, count)
|
||||||
client, device := newSequenceTestClient(t, test.responses...)
|
for i := range responses {
|
||||||
|
responses[i] = cmdResp{status: status(position)}
|
||||||
|
}
|
||||||
|
return responses
|
||||||
|
}
|
||||||
|
|
||||||
_, err := client.PrepareNextCard(context.Background())
|
func TestPreparationClasses(t *testing.T) {
|
||||||
if test.wantError == "" && err != nil {
|
classes := map[preparationClass][]byte{
|
||||||
t.Fatal(err)
|
encoderConfirmed: {0x32, 0x33, 0x36, 0x37, 0x3A, 0x3B, 0x3E, 0x3F},
|
||||||
|
positionUncertain: {0x31, 0x34, 0x35, 0x39, 0x3C, 0x3D},
|
||||||
|
positionWellEmpty: {0x38}, positionNoCard: {0x30},
|
||||||
|
}
|
||||||
|
for want, positions := range classes {
|
||||||
|
for _, position := range positions {
|
||||||
|
st := []byte{0xFF, 0x36, 0x32, position}
|
||||||
|
if got, err := classifyPreparationStatus(st); got != want || err != nil {
|
||||||
|
t.Errorf("classify(% X)=%s,%v, want %s", st, got, err, want)
|
||||||
}
|
}
|
||||||
if test.wantError != "" && (err == nil || !strings.Contains(err.Error(), test.wantError)) {
|
}
|
||||||
t.Fatalf("error = %v, want containing %q", err, test.wantError)
|
}
|
||||||
|
for _, st := range [][]byte{nil, {0x30}, status(0x02), status(0x40), status(0xFF), {0x30, 0x30, 0x30, 0x37, 0x30}} {
|
||||||
|
if got, err := classifyPreparationStatus(st); err == nil {
|
||||||
|
t.Errorf("classify(% X)=%s,nil, want malformed error", st, got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationAllPositionsBothMethods(t *testing.T) {
|
||||||
|
for _, next := range []bool{false, true} {
|
||||||
|
for position := byte(0x30); position <= 0x3F; position++ {
|
||||||
|
t.Run(fmt.Sprintf("next=%t/position=%X", next, position), func(t *testing.T) {
|
||||||
|
responses := positionResponses(position, 40)
|
||||||
|
for i := range responses {
|
||||||
|
responses[i].status[0], responses[i].status[1], responses[i].status[2] = 0xFF, 0x38, 0x34
|
||||||
|
}
|
||||||
|
c, d := newSequenceTestClient(t, responses...)
|
||||||
|
// Passive encoder data must never replace fresh AP.
|
||||||
|
c.lastStatus, c.lastStatusT, c.statusTTL = status(0x33), time.Now(), time.Hour
|
||||||
|
prepare := c.PrepareCurrentCard
|
||||||
|
if next {
|
||||||
|
prepare = c.PrepareNextCard
|
||||||
|
}
|
||||||
|
started := c.now()
|
||||||
|
_, err := prepare(context.Background())
|
||||||
|
wantFC7, wantRS, wantElapsed := 0, 0, time.Duration(0)
|
||||||
|
var wantErr error
|
||||||
|
switch position {
|
||||||
|
case 0x30:
|
||||||
|
wantFC7, wantRS, wantElapsed, wantErr = 4, 3, 18*time.Second, ErrPreparationExhausted
|
||||||
|
case 0x38:
|
||||||
|
wantErr = ErrCardWellEmpty
|
||||||
|
case 0x31, 0x34, 0x35, 0x39, 0x3C, 0x3D:
|
||||||
|
wantFC7, wantElapsed = 1, 4*time.Second
|
||||||
|
}
|
||||||
|
if !errors.Is(err, wantErr) {
|
||||||
|
t.Errorf("prepare(%X) error=%v, want %v", position, err, wantErr)
|
||||||
|
}
|
||||||
|
if commandCount(d.commands, cmdToEncoder) != wantFC7 || commandCount(d.commands, cmdReset) != wantRS {
|
||||||
|
t.Errorf("prepare(%X) commands=%v, want FC7=%d RS=%d", position, d.commands, wantFC7, wantRS)
|
||||||
|
}
|
||||||
|
if got := c.now().Sub(started); got != wantElapsed {
|
||||||
|
t.Errorf("prepare(%X) elapsed=%s, want %s", position, got, wantElapsed)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestThreeShakesAreRequestLocalAndSettled(t *testing.T) {
|
||||||
|
c, d := newSequenceTestClient(t, positionResponses(0x30, 34)...)
|
||||||
|
for request := 0; request < 2; request++ {
|
||||||
|
start := len(d.commands)
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); !errors.Is(err, ErrPreparationExhausted) {
|
||||||
|
t.Fatalf("request %d error=%v, want exhausted", request, err)
|
||||||
|
}
|
||||||
|
want := []cmdType{cmdStatus, cmdToEncoder}
|
||||||
|
for attempt := 0; attempt < 4; attempt++ {
|
||||||
|
want = append(want, cmdStatus, cmdStatus, cmdStatus, cmdStatus)
|
||||||
|
if attempt < 3 {
|
||||||
|
want = append(want, cmdReset, cmdToEncoder)
|
||||||
}
|
}
|
||||||
if got := commandCount(device.commands, cmdToEncoder); got != test.wantToEncoder {
|
}
|
||||||
t.Fatalf("to-encoder commands = %d, want %d", got, test.wantToEncoder)
|
if !reflect.DeepEqual(d.commands[start:], want) {
|
||||||
|
t.Errorf("request %d commands=%v, want %v", request, d.commands[start:], want)
|
||||||
|
}
|
||||||
|
var lastFC7 time.Time
|
||||||
|
for i := start; i < len(d.commands); i++ {
|
||||||
|
if d.commands[i] == cmdReset && d.commandTimes[i].Sub(lastFC7) != 3*time.Second {
|
||||||
|
t.Errorf("RS at %s after FC7, want 3s", d.commandTimes[i].Sub(lastFC7))
|
||||||
|
}
|
||||||
|
if d.commands[i] == cmdToEncoder {
|
||||||
|
if i > start && d.commands[i-1] == cmdReset && d.commandTimes[i].Sub(d.commandTimes[i-1]) != 2*time.Second {
|
||||||
|
t.Errorf("FC7 settle=%s, want 2s", d.commandTimes[i].Sub(d.commandTimes[i-1]))
|
||||||
|
}
|
||||||
|
lastFC7 = d.commandTimes[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationReclassifiesEverySample(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
positions []byte
|
||||||
|
wantRS int
|
||||||
|
wantTime time.Duration
|
||||||
|
wantErr error
|
||||||
|
}{
|
||||||
|
{"uncertain changes do not restart timer", []byte{0x30, 0x31, 0x34, 0x35, 0x39, 0x3C}, 0, 4 * time.Second, nil},
|
||||||
|
{"uncertain becomes encoder", []byte{0x30, 0x34, 0x37}, 0, time.Second, nil},
|
||||||
|
{"uncertain becomes empty", []byte{0x30, 0x34, 0x38}, 0, time.Second, ErrCardWellEmpty},
|
||||||
|
{"no sensors becomes empty", []byte{0x30, 0x30, 0x38}, 0, time.Second, ErrCardWellEmpty},
|
||||||
|
{"uncertain returns to shake path twice", []byte{0x30, 0x34, 0x30, 0x30, 0x30, 0x34, 0x34, 0x30, 0x30, 0x37}, 2, 10 * time.Second, nil},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
var responses []cmdResp
|
||||||
|
for _, p := range tc.positions {
|
||||||
|
responses = append(responses, cmdResp{status: status(p)})
|
||||||
|
}
|
||||||
|
c, d := newSequenceTestClient(t, responses...)
|
||||||
|
start := c.now()
|
||||||
|
_, err := c.PrepareCurrentCard(context.Background())
|
||||||
|
if !errors.Is(err, tc.wantErr) || c.now().Sub(start) != tc.wantTime || commandCount(d.commands, cmdReset) != tc.wantRS {
|
||||||
|
t.Errorf("prepare(%s) error=%v elapsed=%s commands=%v, want error=%v time=%s RS=%d", tc.name, err, c.now().Sub(start), d.commands, tc.wantErr, tc.wantTime, tc.wantRS)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestEveryShakeReclassifiesEncoderEmptyAndUncertain(t *testing.T) {
|
||||||
|
for shake := 1; shake <= 3; shake++ {
|
||||||
|
for _, position := range []byte{0x37, 0x38, 0x35} {
|
||||||
|
responses := positionResponses(0x30, 1+4*shake)
|
||||||
|
responses = append(responses, positionResponses(position, 5)...)
|
||||||
|
c, d := newSequenceTestClient(t, responses...)
|
||||||
|
_, err := c.PrepareCurrentCard(context.Background())
|
||||||
|
var wantErr error
|
||||||
|
if position == 0x38 {
|
||||||
|
wantErr = ErrCardWellEmpty
|
||||||
|
}
|
||||||
|
if !errors.Is(err, wantErr) || commandCount(d.commands, cmdReset) != shake || commandCount(d.commands, cmdToEncoder) != shake+1 {
|
||||||
|
t.Errorf("shake %d position=%X error=%v commands=%v, want %v and no further shake", shake, position, err, d.commands, wantErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationTransportAndDispatchFailuresDoNotShake(t *testing.T) {
|
||||||
|
failure := errors.New("serial failure")
|
||||||
|
for _, response := range []cmdResp{{err: failure}, {status: []byte{0x30}}, {status: status(0x40)}} {
|
||||||
|
c, d := newSequenceTestClient(t, cmdResp{status: status(0x30)}, response)
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Errorf("AP failure %v error=%v, want encoder opportunity", response, err)
|
||||||
|
}
|
||||||
|
if commandCount(d.commands, cmdToEncoder) != 1 || commandCount(d.commands, cmdReset) != 0 {
|
||||||
|
t.Errorf("AP failure commands=%v, want FC7 once and no RS", d.commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, command := range []cmdType{cmdToEncoder, cmdReset} {
|
||||||
|
c, d := newSequenceTestClient(t, positionResponses(0x30, 10)...)
|
||||||
|
d.commandErrors[command] = []error{failure}
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); !errors.Is(err, failure) {
|
||||||
|
t.Errorf("command %v error=%v, want serial failure", command, err)
|
||||||
|
}
|
||||||
|
if commandCount(d.commands, command) != 1 {
|
||||||
|
t.Errorf("command %v retried: %v", command, d.commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationStopsAtCancellationAndDeadlineStages(t *testing.T) {
|
||||||
|
for _, stage := range []string{"initial AP", "FC7", "poll", "RS", "settle"} {
|
||||||
|
for _, callerCanceled := range []bool{false, true} {
|
||||||
|
if stage == "initial AP" && !callerCanceled {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
t.Run(fmt.Sprintf("%s/cancel=%t", stage, callerCanceled), func(t *testing.T) {
|
||||||
|
c, d := newSequenceTestClient(t, positionResponses(0x30, 30)...)
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
t.Cleanup(cancel)
|
||||||
|
now := c.now()
|
||||||
|
c.sequenceTiming.now = func() time.Time { return now }
|
||||||
|
stoppedAt := -1
|
||||||
|
stop := func() {
|
||||||
|
if stoppedAt >= 0 {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
stoppedAt = len(d.commands)
|
||||||
|
if callerCanceled {
|
||||||
|
cancel()
|
||||||
|
} else {
|
||||||
|
now = now.Add(sequenceTimeout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c.sequenceTiming.wait = func(_ context.Context, duration time.Duration) error {
|
||||||
|
now = now.Add(duration)
|
||||||
|
if (stage == "poll" && duration == sequencePollInterval) || (stage == "settle" && duration == sequenceResetWait) {
|
||||||
|
stop()
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
d.onCommand = func(cmd cmdType) {
|
||||||
|
if (stage == "initial AP" && cmd == cmdStatus) || (stage == "FC7" && cmd == cmdToEncoder) || (stage == "RS" && cmd == cmdReset) {
|
||||||
|
stop()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_, err := c.PrepareCurrentCard(ctx)
|
||||||
|
wantErr := error(ErrPreparationExhausted)
|
||||||
|
if callerCanceled {
|
||||||
|
wantErr = context.Canceled
|
||||||
|
} else if stage == "initial AP" {
|
||||||
|
wantErr = context.DeadlineExceeded
|
||||||
|
}
|
||||||
|
if !errors.Is(err, wantErr) || len(d.commands) != stoppedAt {
|
||||||
|
t.Errorf("stage=%s cancel=%t error=%v commands=%v stoppedAt=%d, want %v and no commands after stop", stage, callerCanceled, err, d.commands, stoppedAt, wantErr)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPositionFlagsRemainDiagnostic(t *testing.T) {
|
||||||
|
for position := byte(0x30); position <= 0x3F; position++ {
|
||||||
|
st := status(position)
|
||||||
|
if got := isAtEncoderPosition(st); got != (position&0x02 != 0) {
|
||||||
|
t.Errorf("encoder sensor(%X)=%t", position, got)
|
||||||
|
}
|
||||||
|
if got := isCardWellEmpty(st); got != (position&0x08 != 0) {
|
||||||
|
t.Errorf("stock empty flag(%X)=%t", position, got)
|
||||||
|
}
|
||||||
|
wantStock := ""
|
||||||
|
if position&0x08 != 0 {
|
||||||
|
wantStock = "Card empty"
|
||||||
|
}
|
||||||
|
if got := stockTake(st); got != wantStock {
|
||||||
|
t.Errorf("stockTake(%X)=%q, want %q", position, got, wantStock)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationCallerDeadlineIsNotRetryableExhaustion(t *testing.T) {
|
||||||
|
c, d := newSequenceTestClient(t)
|
||||||
|
ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(-time.Second))
|
||||||
|
defer cancel()
|
||||||
|
_, err := c.PrepareCurrentCard(ctx)
|
||||||
|
if !errors.Is(err, context.DeadlineExceeded) || errors.Is(err, ErrPreparationExhausted) || len(d.commands) != 0 {
|
||||||
|
t.Errorf("expired caller: err=%v commands=%v, want caller deadline and no commands", err, d.commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestPreparationExpiredEncoderSampleHandsOff(t *testing.T) {
|
||||||
|
c, d := newSequenceTestClient(t, cmdResp{status: status(0x30)}, cmdResp{status: status(0x37)})
|
||||||
|
now := c.now()
|
||||||
|
c.sequenceTiming.now = func() time.Time { return now }
|
||||||
|
d.onCommand = func(cmd cmdType) {
|
||||||
|
if cmd == cmdStatus && commandCount(d.commands, cmdStatus) == 2 {
|
||||||
|
now = now.Add(sequenceTimeout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_, err := c.PrepareCurrentCard(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("late encoder sample: err=%v, want handoff", err)
|
||||||
|
}
|
||||||
|
if len(d.commands) != 3 {
|
||||||
|
t.Errorf("late encoder sample commands=%v, want AP FC7 AP", d.commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,242 @@
|
|||||||
|
package dispenser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestStrictAPFailuresBecomeUnusablePreparationObservations(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
chunks [][]byte
|
||||||
|
readErr error
|
||||||
|
}{
|
||||||
|
{"invalid ACK 10 06 30", [][]byte{{0x10, 0x06, 0x30}}, nil},
|
||||||
|
{"truncated", [][]byte{vendorACK, vendorAP[:8]}, nil},
|
||||||
|
{"no response", nil, nil},
|
||||||
|
{"timeout", nil, context.DeadlineExceeded},
|
||||||
|
{"read failure", nil, io.ErrClosedPipe},
|
||||||
|
}
|
||||||
|
for _, offset := range []int{0, 1, 2, 3, 4, 5, 6, 11, 12} {
|
||||||
|
frame := append([]byte(nil), vendorAP...)
|
||||||
|
frame[offset] ^= 0xff
|
||||||
|
if offset == 5 || offset == 6 || offset == 11 {
|
||||||
|
frame[12] = calculateBCC(frame[:12])
|
||||||
|
}
|
||||||
|
cases = append(cases, struct {
|
||||||
|
name string
|
||||||
|
chunks [][]byte
|
||||||
|
readErr error
|
||||||
|
}{fmt.Sprintf("frame byte %d", offset), [][]byte{vendorACK, frame}, nil})
|
||||||
|
}
|
||||||
|
for _, tc := range cases {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{chunks: tc.chunks, readErr: tc.readErr}
|
||||||
|
st, err := queryStatus(context.Background(), p, vendorFrames[0].command, 4, 0)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("strict queryStatus accepted invalid transaction")
|
||||||
|
}
|
||||||
|
c, d := newSequenceTestClient(t, cmdResp{status: st, err: err}, cmdResp{status: status(0x37)})
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Errorf("preparation after %s = %v, want opportunity", tc.name, err)
|
||||||
|
}
|
||||||
|
if commandCount(d.commands, cmdToEncoder) != 1 || commandCount(d.commands, cmdReset) != 0 {
|
||||||
|
t.Errorf("commands=%v, want one FC7 and no RS", d.commands)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestUnusableObservationsReclassifyAndShareUncertainty(t *testing.T) {
|
||||||
|
for _, later := range []byte{0x38, 0x30, 0x37, 0x35, 0x40} {
|
||||||
|
t.Run(fmt.Sprintf("later %X", later), func(t *testing.T) {
|
||||||
|
responses := []cmdResp{{err: io.ErrUnexpectedEOF}, {status: status(0x40)}}
|
||||||
|
responses = append(responses, positionResponses(later, 25)...)
|
||||||
|
c, d := newSequenceTestClient(t, responses...)
|
||||||
|
_, err := c.PrepareCurrentCard(context.Background())
|
||||||
|
var want error
|
||||||
|
if later == 0x38 {
|
||||||
|
want = ErrCardWellEmpty
|
||||||
|
}
|
||||||
|
if later == 0x30 {
|
||||||
|
want = ErrPreparationExhausted
|
||||||
|
}
|
||||||
|
if !errors.Is(err, want) {
|
||||||
|
t.Errorf("later %X error=%v, want %v", later, err, want)
|
||||||
|
}
|
||||||
|
resets := 0
|
||||||
|
if later == 0x30 {
|
||||||
|
resets = 3
|
||||||
|
}
|
||||||
|
if commandCount(d.commands, cmdReset) != resets {
|
||||||
|
t.Errorf("later %X commands=%v, want %d RS", later, d.commands, resets)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
c, d := newSequenceTestClient(t, cmdResp{err: io.EOF}, cmdResp{err: io.EOF}, cmdResp{status: status(0x35)}, cmdResp{status: status(0x40)}, cmdResp{err: io.EOF}, cmdResp{status: status(0x39)})
|
||||||
|
start := c.now()
|
||||||
|
if _, err := c.PrepareCurrentCard(context.Background()); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if elapsed := c.now().Sub(start); elapsed != sequenceUncertainWait {
|
||||||
|
t.Errorf("mixed uncertainty elapsed=%v, want %v", elapsed, sequenceUncertainWait)
|
||||||
|
}
|
||||||
|
if commandCount(d.commands, cmdToEncoder) != 1 {
|
||||||
|
t.Errorf("mixed uncertainty commands=%v, want one FC7", d.commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestObservationAtPreparationDeadline(t *testing.T) {
|
||||||
|
for _, last := range []cmdResp{{err: io.EOF}, {status: status(0x40)}, {status: status(0x35)}, {status: status(0x30)}, {status: status(0x38)}} {
|
||||||
|
c, d := newSequenceTestClient(t, cmdResp{status: status(0x30)}, last)
|
||||||
|
now := c.now()
|
||||||
|
c.sequenceTiming.now = func() time.Time { return now }
|
||||||
|
d.onCommand = func(cmd cmdType) {
|
||||||
|
if cmd == cmdStatus && commandCount(d.commands, cmdStatus) == 2 {
|
||||||
|
now = now.Add(sequenceTimeout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_, err := c.PrepareCurrentCard(context.Background())
|
||||||
|
var want error
|
||||||
|
if len(last.status) == 4 && last.status[3] == 0x30 {
|
||||||
|
want = ErrPreparationExhausted
|
||||||
|
}
|
||||||
|
if len(last.status) == 4 && last.status[3] == 0x38 {
|
||||||
|
want = ErrCardWellEmpty
|
||||||
|
}
|
||||||
|
if !errors.Is(err, want) {
|
||||||
|
t.Errorf("deadline observation=%v error=%v, want %v", last, err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWorkerClearanceFallbackAndMovement(t *testing.T) {
|
||||||
|
for _, mode := range []string{"unusable", "ambiguous", "movement", "movement then unusable", "empty", "cancel"} {
|
||||||
|
t.Run(mode, func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{}
|
||||||
|
for i := 0; i < 6; i++ {
|
||||||
|
switch mode {
|
||||||
|
case "unusable", "cancel":
|
||||||
|
p.chunks = append(p.chunks, []byte{0x10, 0x06, 0x30})
|
||||||
|
case "ambiguous":
|
||||||
|
p.chunks = append(p.chunks, vendorACK, apReply(status(0x37)))
|
||||||
|
case "empty":
|
||||||
|
p.chunks = append(p.chunks, vendorACK, apReply(status(0x38)))
|
||||||
|
default:
|
||||||
|
if mode == "movement then unusable" && i > 0 {
|
||||||
|
p.chunks = append(p.chunks, []byte{0x10, 0x06, 0x30})
|
||||||
|
} else {
|
||||||
|
p.chunks = append(p.chunks, vendorACK, apReply([]byte{0x31, 0x30, 0x30, 0x34}))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c, now := deliveryWorkerClient(t, p)
|
||||||
|
c.sequenceTiming.wait = func(ctx context.Context, d time.Duration) error {
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return ctx.Err()
|
||||||
|
}
|
||||||
|
*now = now.Add(2 * d)
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
c.deliveryPending = true
|
||||||
|
c.deliveryStarted = c.now()
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
if mode == "cancel" {
|
||||||
|
p.afterRead = cancel
|
||||||
|
}
|
||||||
|
r := c.doResponse(ctx, cmdDeliveryClearance)
|
||||||
|
if mode == "cancel" {
|
||||||
|
if !errors.Is(r.err, context.Canceled) {
|
||||||
|
t.Errorf("cancel=%v", r.err)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
var want error
|
||||||
|
if mode == "movement" {
|
||||||
|
want = context.DeadlineExceeded
|
||||||
|
}
|
||||||
|
if mode == "empty" {
|
||||||
|
want = ErrCardWellEmpty
|
||||||
|
}
|
||||||
|
if !errors.Is(r.err, want) {
|
||||||
|
t.Errorf("clearance %s error=%v want %v", mode, r.err, want)
|
||||||
|
}
|
||||||
|
if c.deliveryPending != (want != nil) {
|
||||||
|
t.Errorf("clearance %s pending=%t", mode, c.deliveryPending)
|
||||||
|
}
|
||||||
|
if mode != "empty" && now.Sub(time.Unix(0, 0)) != deliveryClearanceTimeout {
|
||||||
|
t.Errorf("clearance %s wait=%v want 6s", mode, now.Sub(time.Unix(0, 0)))
|
||||||
|
}
|
||||||
|
for _, command := range wireCommands(p) {
|
||||||
|
if command != "AP" {
|
||||||
|
t.Errorf("clearance issued %s, want AP only", command)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestWorkerAssumedClearanceAllowsOneFC7(t *testing.T) {
|
||||||
|
for _, prepare := range []bool{false, true} {
|
||||||
|
p := &scriptedTransport{}
|
||||||
|
dispatched := false
|
||||||
|
p.afterWrite = func() {
|
||||||
|
w := p.writes[len(p.writes)-1]
|
||||||
|
if len(w) <= 6 || w[0] != STX {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
switch string(w[5 : len(w)-2]) {
|
||||||
|
case "AP":
|
||||||
|
if dispatched {
|
||||||
|
p.chunks = append(p.chunks, vendorACK, apReply(status(0x35)))
|
||||||
|
} else {
|
||||||
|
p.chunks = append(p.chunks, []byte{0x10, 0x06, 0x30})
|
||||||
|
}
|
||||||
|
case "FC7":
|
||||||
|
dispatched = true
|
||||||
|
p.chunks = append(p.chunks, vendorACK)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
c, now := deliveryWorkerClient(t, p)
|
||||||
|
c.deliveryPending = true
|
||||||
|
c.deliveryStarted = c.now()
|
||||||
|
var err error
|
||||||
|
if prepare {
|
||||||
|
_, err = c.PrepareCurrentCard(context.Background())
|
||||||
|
} else {
|
||||||
|
err = c.BeginPrepareNextCard(context.Background())
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("prepare=%t error=%v", prepare, err)
|
||||||
|
}
|
||||||
|
wantElapsed := deliveryClearanceTimeout
|
||||||
|
if prepare {
|
||||||
|
wantElapsed += sequenceUncertainWait
|
||||||
|
}
|
||||||
|
if elapsed := now.Sub(time.Unix(0, 0)); elapsed != wantElapsed {
|
||||||
|
t.Errorf("prepare=%t elapsed=%v want %v", prepare, elapsed, wantElapsed)
|
||||||
|
}
|
||||||
|
commands := wireCommands(p)
|
||||||
|
fc7 := 0
|
||||||
|
for _, cmd := range commands {
|
||||||
|
if cmd == "FC7" {
|
||||||
|
fc7++
|
||||||
|
}
|
||||||
|
if cmd == "RS" {
|
||||||
|
t.Errorf("unexpected RS: %v", commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if fc7 != 1 || c.deliveryPending {
|
||||||
|
t.Errorf("prepare=%t commands=%v pending=%t, want one FC7 and cleared", prepare, commands, c.deliveryPending)
|
||||||
|
}
|
||||||
|
if !prepare && commands[len(commands)-1] != "FC7" {
|
||||||
|
t.Errorf("prestaging polled after FC7: %v", commands)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,272 @@
|
|||||||
|
package dispenser
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Golden frames reconstructed from K720_Dll.dll's big-endian length and XOR
|
||||||
|
// algorithm (SendCmd 0x100050C0, Query 0x10005280, SensorQuery 0x10005420).
|
||||||
|
var vendorFrames = []struct {
|
||||||
|
name string
|
||||||
|
command []byte
|
||||||
|
frame []byte
|
||||||
|
}{
|
||||||
|
{"AP", []byte{2, 'A', 'P'}, []byte{2, 0x30, 0x30, 0, 2, 0x41, 0x50, 3, 0x12}},
|
||||||
|
{"RF", []byte{2, 'R', 'F'}, []byte{2, 0x30, 0x30, 0, 2, 0x52, 0x46, 3, 0x17}},
|
||||||
|
{"FC7", commandFC7, []byte{2, 0x30, 0x30, 0, 3, 0x46, 0x43, 0x37, 3, 0x30}},
|
||||||
|
{"FC0", commandFC0, []byte{2, 0x30, 0x30, 0, 3, 0x46, 0x43, 0x30, 3, 0x37}},
|
||||||
|
{"RS", commandRS, []byte{2, 0x30, 0x30, 0, 2, 0x52, 0x53, 3, 2}},
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVendorOutboundFrames(t *testing.T) {
|
||||||
|
for _, tc := range vendorFrames {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
if got := createPacket([]byte("00"), tc.command); !bytes.Equal(got, tc.frame) {
|
||||||
|
t.Errorf("createPacket(%s) = % X, want % X", tc.name, got, tc.frame)
|
||||||
|
}
|
||||||
|
if got := calculateBCC(tc.frame[:len(tc.frame)-1]); got != tc.frame[len(tc.frame)-1] {
|
||||||
|
t.Errorf("calculateBCC(%s) = %02X, want %02X", tc.name, got, tc.frame[len(tc.frame)-1])
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type scriptedTransport struct {
|
||||||
|
chunks [][]byte
|
||||||
|
writes [][]byte
|
||||||
|
readErr error
|
||||||
|
writeErr error
|
||||||
|
shortWrite int
|
||||||
|
afterRead func()
|
||||||
|
afterWrite func()
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *scriptedTransport) Read(b []byte) (int, error) {
|
||||||
|
if len(p.chunks) == 0 {
|
||||||
|
if p.readErr != nil {
|
||||||
|
return 0, p.readErr
|
||||||
|
}
|
||||||
|
return 0, io.EOF
|
||||||
|
}
|
||||||
|
n := copy(b, p.chunks[0])
|
||||||
|
p.chunks[0] = p.chunks[0][n:]
|
||||||
|
if len(p.chunks[0]) == 0 {
|
||||||
|
p.chunks = p.chunks[1:]
|
||||||
|
}
|
||||||
|
if p.afterRead != nil {
|
||||||
|
p.afterRead()
|
||||||
|
}
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
|
func (p *scriptedTransport) Write(b []byte) (int, error) {
|
||||||
|
p.writes = append(p.writes, append([]byte(nil), b...))
|
||||||
|
if p.afterWrite != nil {
|
||||||
|
p.afterWrite()
|
||||||
|
}
|
||||||
|
if p.writeErr != nil {
|
||||||
|
return 0, p.writeErr
|
||||||
|
}
|
||||||
|
if p.shortWrite == len(p.writes) {
|
||||||
|
return len(b) - 1, nil
|
||||||
|
}
|
||||||
|
return len(b), nil
|
||||||
|
}
|
||||||
|
func transportAddress(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
old := Address
|
||||||
|
Address = []byte("00")
|
||||||
|
t.Cleanup(func() { Address = old })
|
||||||
|
}
|
||||||
|
|
||||||
|
// Independent SF response vectors: status is 30 30 30 [33].
|
||||||
|
var vendorAP = []byte{2, 0x30, 0x30, 0, 6, 'S', 'F', 0x30, 0x30, 0x30, 0x33, 3, 0x11}
|
||||||
|
var vendorRF = []byte{2, 0x30, 0x30, 0, 5, 'S', 'F', 0x30, 0x30, 0x30, 3, 0x21}
|
||||||
|
var vendorACK = []byte{6, 0x30, 0x30}
|
||||||
|
|
||||||
|
func TestVendorQueryFragmentation(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
for i, frame := range [][]byte{vendorAP, vendorRF} {
|
||||||
|
wire := append(append([]byte(nil), vendorACK...), frame...)
|
||||||
|
for split := 1; split < len(wire); split++ {
|
||||||
|
t.Run(fmt.Sprintf("%s/split%d", vendorFrames[i].name, split), func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{wire[:split], wire[split:]}}
|
||||||
|
got, err := queryStatus(context.Background(), p, vendorFrames[i].command, 4-i, 0)
|
||||||
|
if err != nil || !bytes.Equal(got, frame[7:len(frame)-2]) {
|
||||||
|
t.Fatalf("queryStatus(split=%d) = % X, %v, want % X, nil", split, got, err, frame[7:len(frame)-2])
|
||||||
|
}
|
||||||
|
if len(p.writes) != 2 || !bytes.Equal(p.writes[0], vendorFrames[i].frame) || !bytes.Equal(p.writes[1], []byte{5, 0x30, 0x30}) {
|
||||||
|
t.Errorf("queryStatus writes = % X, want command then ENQ", p.writes)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
t.Run(vendorFrames[i].name+"/one-byte", func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{}
|
||||||
|
for _, b := range wire {
|
||||||
|
p.chunks = append(p.chunks, []byte{b})
|
||||||
|
}
|
||||||
|
if _, err := queryStatus(context.Background(), p, vendorFrames[i].command, 4-i, 0); err != nil {
|
||||||
|
t.Errorf("queryStatus(one-byte reads) = %v, want nil", err)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestVendorQueryRejectsInvalidFrames(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
offset int
|
||||||
|
value byte
|
||||||
|
}{
|
||||||
|
{"STX", 0, 1}, {"address high", 1, '1'}, {"address low", 2, '1'},
|
||||||
|
{"zero length", 4, 0}, {"short length", 4, 5}, {"long length", 4, 7}, {"high length", 3, 0xff},
|
||||||
|
{"type S", 5, 'X'}, {"type F", 6, 'X'}, {"ETX", 11, 4}, {"BCC", 12, 0},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
frame := append([]byte(nil), vendorAP...)
|
||||||
|
frame[tc.offset] = tc.value
|
||||||
|
// Keep checksum valid when testing type/ETX to isolate those checks.
|
||||||
|
if tc.offset == 5 || tc.offset == 6 || tc.offset == 11 {
|
||||||
|
frame[12] = 0
|
||||||
|
for _, b := range frame[:12] {
|
||||||
|
frame[12] ^= b
|
||||||
|
}
|
||||||
|
}
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, frame}}
|
||||||
|
if got, err := queryStatus(context.Background(), p, vendorFrames[0].command, 4, 0); err == nil || got != nil {
|
||||||
|
t.Errorf("queryStatus(%s) = % X, %v, want nil/error", tc.name, got, err)
|
||||||
|
}
|
||||||
|
if len(p.writes) != 2 {
|
||||||
|
t.Errorf("queryStatus(%s) writes=%d, want 2 without resend", tc.name, len(p.writes))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
for n := 0; n < len(vendorAP); n++ {
|
||||||
|
t.Run(fmt.Sprintf("truncated%d", n), func(t *testing.T) {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, vendorAP[:n]}}
|
||||||
|
if _, err := queryStatus(context.Background(), p, vendorFrames[0].command, 4, 0); err == nil {
|
||||||
|
t.Errorf("queryStatus(%d-byte frame) succeeded, want error", n)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTransportACKAndMechanicalDispatch(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
for _, tc := range vendorFrames[2:] {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{{6}, {'0'}, {'0'}}}
|
||||||
|
if err := dispatchCommand(context.Background(), p, tc.command, 0); err != nil {
|
||||||
|
t.Fatalf("dispatchCommand(%s)=%v, want nil", tc.name, err)
|
||||||
|
}
|
||||||
|
if len(p.writes) != 2 || !bytes.Equal(p.writes[0], tc.frame) || !bytes.Equal(p.writes[1], []byte{5, '0', '0'}) {
|
||||||
|
t.Errorf("dispatchCommand(%s) writes=% X, want command then ENQ", tc.name, p.writes)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, ack := range [][]byte{{0x15, '0', '0'}, {6, '1', '0'}, {6, '0', '1'}, {6}, {6, '0'}, {}} {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{ack}}
|
||||||
|
if err := dispatchCommand(context.Background(), p, commandFC7, 0); err == nil {
|
||||||
|
t.Errorf("dispatchCommand(ACK=% X) succeeded, want error", ack)
|
||||||
|
}
|
||||||
|
if len(p.writes) != 1 {
|
||||||
|
t.Errorf("dispatchCommand(ACK=% X) writes=%d, want 1", ack, len(p.writes))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTransportShortWritesAndErrors(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
failure := errors.New("serial failure")
|
||||||
|
for _, stage := range []int{1, 2} {
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK}, shortWrite: stage}
|
||||||
|
if err := dispatchCommand(context.Background(), p, commandFC7, 0); !errors.Is(err, io.ErrShortWrite) {
|
||||||
|
t.Errorf("dispatchCommand(short write %d)=%v, want ErrShortWrite", stage, err)
|
||||||
|
}
|
||||||
|
if len(p.writes) != stage {
|
||||||
|
t.Errorf("short write %d writes=%d, want %d", stage, len(p.writes), stage)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, p := range []*scriptedTransport{{writeErr: failure}, {readErr: failure}, {chunks: [][]byte{{}}}} {
|
||||||
|
if err := dispatchCommand(context.Background(), p, commandRS, 0); err == nil {
|
||||||
|
t.Error("dispatchCommand(I/O failure) succeeded, want error")
|
||||||
|
}
|
||||||
|
if len(p.writes) != 1 {
|
||||||
|
t.Errorf("dispatchCommand(I/O failure) writes=%d, want 1", len(p.writes))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTransportCancellation(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
for _, stage := range []string{"before write", "processing wait", "after ACK", "after ENQ", "after header"} {
|
||||||
|
t.Run(stage, func(t *testing.T) {
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, vendorAP}}
|
||||||
|
wantWrites := 1
|
||||||
|
switch stage {
|
||||||
|
case "before write":
|
||||||
|
cancel()
|
||||||
|
wantWrites = 0
|
||||||
|
case "processing wait":
|
||||||
|
p.afterWrite = cancel
|
||||||
|
case "after ACK":
|
||||||
|
p.afterRead = cancel
|
||||||
|
case "after ENQ":
|
||||||
|
wantWrites = 2
|
||||||
|
p.afterWrite = func() {
|
||||||
|
if len(p.writes) == 2 {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
case "after header":
|
||||||
|
wantWrites = 2
|
||||||
|
reads := 0
|
||||||
|
p.afterRead = func() {
|
||||||
|
reads++
|
||||||
|
if reads == 2 {
|
||||||
|
cancel()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := queryStatus(ctx, p, vendorFrames[0].command, 4, 0); !errors.Is(err, context.Canceled) {
|
||||||
|
t.Errorf("queryStatus(cancel %s)=%v, want Canceled", stage, err)
|
||||||
|
}
|
||||||
|
if len(p.writes) != wantWrites {
|
||||||
|
t.Errorf("queryStatus(cancel %s) writes=%d, want %d", stage, len(p.writes), wantWrites)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Millisecond)
|
||||||
|
defer cancel()
|
||||||
|
p := &scriptedTransport{}
|
||||||
|
if err := dispatchCommand(ctx, p, commandRS, time.Second); !errors.Is(err, context.DeadlineExceeded) {
|
||||||
|
t.Errorf("dispatchCommand(deadline in wait)=%v, want DeadlineExceeded", err)
|
||||||
|
}
|
||||||
|
if len(p.writes) != 1 {
|
||||||
|
t.Errorf("dispatchCommand(deadline) writes=%d, want 1", len(p.writes))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestTransportTrailingDataNotConsumedAsStatus(t *testing.T) {
|
||||||
|
transportAddress(t)
|
||||||
|
frame := append(append([]byte(nil), vendorAP...), 0xff, 0xfe, 0xfd)
|
||||||
|
p := &scriptedTransport{chunks: [][]byte{vendorACK, frame}}
|
||||||
|
if _, err := queryStatus(context.Background(), p, vendorFrames[0].command, 4, 0); err != nil {
|
||||||
|
t.Fatalf("queryStatus(frame with trailing bytes)=%v, want nil", err)
|
||||||
|
}
|
||||||
|
if len(p.chunks) != 1 || !bytes.Equal(p.chunks[0], []byte{0xff, 0xfe, 0xfd}) {
|
||||||
|
t.Fatalf("remaining bytes=% X, want FF FE FD", p.chunks)
|
||||||
|
}
|
||||||
|
if err := dispatchCommand(context.Background(), p, commandFC7, 0); err == nil {
|
||||||
|
t.Error("dispatchCommand(trailing garbage) succeeded, want invalid ACK")
|
||||||
|
}
|
||||||
|
if len(p.writes) != 3 {
|
||||||
|
t.Errorf("writes after trailing garbage=%d, want 3 (no ENQ/resend)", len(p.writes))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
package handlers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
|
||||||
|
"gitea.futuresens.co.uk/futuresens/cmstypes"
|
||||||
|
"gitea.futuresens.co.uk/futuresens/hardlink/internal/creditcall"
|
||||||
|
"gitea.futuresens.co.uk/futuresens/hardlink/internal/types"
|
||||||
|
"gitea.futuresens.co.uk/futuresens/logging"
|
||||||
|
)
|
||||||
|
|
||||||
|
type creditCallPreauthRequest struct {
|
||||||
|
Amount string `json:"amount"`
|
||||||
|
TransactionType string `json:"transactionType"`
|
||||||
|
CheckoutDate string `json:"checkoutDate"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (app *App) streamCreditCallPreauth(w http.ResponseWriter, r *http.Request) {
|
||||||
|
app.streamCreditCall(w, r, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
// executeCreditCallPreauth finalizes the existing unconfirmed transaction.
|
||||||
|
// The outcome container and its wire projections are shared with SALE; its execution is not.
|
||||||
|
func (app *App) executeCreditCallPreauth(ctx context.Context, request cmstypes.TransactionRec,
|
||||||
|
start func(*http.Client) (creditcall.TransactionResultXML, error)) creditCallSaleOutcome {
|
||||||
|
const op = logging.Op("takePreauthorization")
|
||||||
|
outcome := creditCallSaleOutcome{
|
||||||
|
HTTPStatus: http.StatusBadGateway,
|
||||||
|
Status: cmstypes.StatusRec{Code: http.StatusInternalServerError, Message: "500 Internal server error"},
|
||||||
|
}
|
||||||
|
transaction, err := start(app.creditCallClient())
|
||||||
|
if err != nil {
|
||||||
|
logging.Error(types.ServiceName, err.Error(), "Preauth processing error", string(op), "", "", 0)
|
||||||
|
outcome.FailureType = types.ResultError
|
||||||
|
outcome.FailureDescription = "No response from payment processor"
|
||||||
|
return outcome
|
||||||
|
}
|
||||||
|
var result creditcall.PaymentResult
|
||||||
|
result.FillFromTransactionResult(transaction)
|
||||||
|
app.printCreditCallReceipt(result.CardholderReceipt)
|
||||||
|
approved, persist := creditcall.PreauthDecision(result.Fields)
|
||||||
|
outcome.HTTPStatus = http.StatusOK
|
||||||
|
outcome.Status = result.Status
|
||||||
|
outcome.Payment = result
|
||||||
|
outcome.Approved = approved
|
||||||
|
outcome.FailureType = result.Fields[types.TransactionResult]
|
||||||
|
outcome.FailureDescription = result.Fields[types.Errors]
|
||||||
|
if persist {
|
||||||
|
go app.persistPreauth(ctx, result.Fields, request.CheckoutDate)
|
||||||
|
}
|
||||||
|
return outcome
|
||||||
|
}
|
||||||
@@ -0,0 +1,393 @@
|
|||||||
|
package handlers
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"database/sql"
|
||||||
|
"database/sql/driver"
|
||||||
|
"encoding/json"
|
||||||
|
"encoding/xml"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"sync/atomic"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.futuresens.co.uk/futuresens/cmstypes"
|
||||||
|
"gitea.futuresens.co.uk/futuresens/hardlink/internal/types"
|
||||||
|
"gitea.futuresens.co.uk/futuresens/hardlink/paymentstatus"
|
||||||
|
)
|
||||||
|
|
||||||
|
type preauthTestConnector struct {
|
||||||
|
inserts chan []driver.NamedValue
|
||||||
|
count atomic.Int32
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c *preauthTestConnector) Connect(context.Context) (driver.Conn, error) {
|
||||||
|
return &preauthTestConn{c}, nil
|
||||||
|
}
|
||||||
|
func (c *preauthTestConnector) Driver() driver.Driver { return preauthTestDriver{c} }
|
||||||
|
|
||||||
|
type preauthTestDriver struct{ c *preauthTestConnector }
|
||||||
|
|
||||||
|
func (d preauthTestDriver) Open(string) (driver.Conn, error) { return &preauthTestConn{d.c}, nil }
|
||||||
|
|
||||||
|
type preauthTestConn struct{ c *preauthTestConnector }
|
||||||
|
|
||||||
|
func (*preauthTestConn) Prepare(string) (driver.Stmt, error) {
|
||||||
|
return nil, errors.New("unexpected prepare")
|
||||||
|
}
|
||||||
|
func (*preauthTestConn) Close() error { return nil }
|
||||||
|
func (*preauthTestConn) Begin() (driver.Tx, error) { return nil, errors.New("unexpected begin") }
|
||||||
|
func (*preauthTestConn) Ping(context.Context) error { return nil }
|
||||||
|
func (c *preauthTestConn) ExecContext(ctx context.Context, query string, args []driver.NamedValue) (driver.Result, error) {
|
||||||
|
if ctx.Err() != nil {
|
||||||
|
return nil, ctx.Err()
|
||||||
|
}
|
||||||
|
if !strings.Contains(query, "INSERT INTO dbo.Preauthorizations") {
|
||||||
|
return nil, errors.New("unexpected SQL")
|
||||||
|
}
|
||||||
|
c.c.count.Add(1)
|
||||||
|
c.c.inserts <- append([]driver.NamedValue(nil), args...)
|
||||||
|
return driver.RowsAffected(1), nil
|
||||||
|
}
|
||||||
|
func preauthTestDatabase(t *testing.T, app *App) *preauthTestConnector {
|
||||||
|
t.Helper()
|
||||||
|
c := &preauthTestConnector{inserts: make(chan []driver.NamedValue, 4)}
|
||||||
|
app.db = sql.OpenDB(c)
|
||||||
|
app.cfg.LogDir = t.TempDir()
|
||||||
|
t.Cleanup(func() { app.db.Close() })
|
||||||
|
return c
|
||||||
|
}
|
||||||
|
func waitPreauthInsert(t *testing.T, c *preauthTestConnector) map[string]any {
|
||||||
|
t.Helper()
|
||||||
|
select {
|
||||||
|
case args := <-c.inserts:
|
||||||
|
result := map[string]any{}
|
||||||
|
for _, arg := range args {
|
||||||
|
result[arg.Name] = arg.Value
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
t.Fatal("preauth persistence did not reach SQL")
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
func preauthLegacyRequest(amount, kind, checkout string) *http.Request {
|
||||||
|
body, _ := xml.Marshal(cmstypes.TransactionRec{AmountMinorUnits: amount, TransactionType: kind, CheckoutDate: checkout})
|
||||||
|
r := httptest.NewRequest(http.MethodPost, "/takepreauth", strings.NewReader(string(body)))
|
||||||
|
r.Header.Set("Content-Type", "text/xml")
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCreditCallPreauthLegacyCharacterization(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name, amount, requestType, result, resultType, total string
|
||||||
|
save, approved bool
|
||||||
|
}{
|
||||||
|
{"positive", "12000", "Sale", "APPROVED", "SALE", "3100", true, true},
|
||||||
|
{"declined", "12000", "Sale", "DECLINED", "SALE", "", false, false},
|
||||||
|
{"verification", "", "AccountVerification", "APPROVED", "ACCOUNT VERIFICATION", "", false, true},
|
||||||
|
{"verification failure", "", "AccountVerification", "DECLINED", "ACCOUNT VERIFICATION", "", false, false},
|
||||||
|
{"unexpected type", "12000", "Sale", "APPROVED", "Refund", "", false, false},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
var starts, prints int
|
||||||
|
checkout := ""
|
||||||
|
if tc.amount != "" {
|
||||||
|
checkout = "2026-09-11 00:00:00 +0000"
|
||||||
|
}
|
||||||
|
fields := map[string]string{types.TransactionResult: tc.result, types.TransactionType: tc.resultType, types.Reference: "preauth-ref", types.PanMasked: "************1133", types.CardType: "Visa", types.ExpiryDate: "1228", types.CardHash: "card-hash", types.CardReference: "card-reference", types.ReceiptDataCardholder: "receipt"}
|
||||||
|
if tc.total != "" {
|
||||||
|
fields[types.TotalAmount] = tc.total
|
||||||
|
}
|
||||||
|
app := newCreditCallTestApp(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
starts++
|
||||||
|
if r.URL.Path != "/start-transaction/" {
|
||||||
|
t.Errorf("PREAUTH upstream path=%s, want start only", r.URL.Path)
|
||||||
|
}
|
||||||
|
var input cmstypes.TransactionRec
|
||||||
|
if err := xml.NewDecoder(r.Body).Decode(&input); err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
if input.AmountMinorUnits != tc.amount || input.TransactionType != tc.requestType || input.CheckoutDate != checkout {
|
||||||
|
t.Errorf("PREAUTH input=%+v, want amount=%q type=%q checkout=%q", input, tc.amount, tc.requestType, checkout)
|
||||||
|
}
|
||||||
|
// Legacy ignores upstream HTTP status when XML contains a result.
|
||||||
|
w.WriteHeader(http.StatusBadGateway)
|
||||||
|
io.WriteString(w, chipDNAFixture(t, fields))
|
||||||
|
})
|
||||||
|
c := preauthTestDatabase(t, app)
|
||||||
|
app.creditCallReceipt = func(receipt string) {
|
||||||
|
prints++
|
||||||
|
if receipt != "receipt" {
|
||||||
|
t.Errorf("receipt=%q, want receipt", receipt)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
recorder := httptest.NewRecorder()
|
||||||
|
app.takePreauthorization(recorder, preauthLegacyRequest(tc.amount, tc.requestType, checkout))
|
||||||
|
var response cmstypes.ResponseRec
|
||||||
|
if err := json.Unmarshal(recorder.Body.Bytes(), &response); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if recorder.Code != 200 || response.Status.Code != 200 || starts != 1 || prints != 1 || strings.HasPrefix(response.Data, "/successful?") != tc.approved {
|
||||||
|
t.Errorf("PREAUTH response=%+v HTTP=%d starts=%d prints=%d, want approved=%t one start/receipt", response, recorder.Code, starts, prints, tc.approved)
|
||||||
|
}
|
||||||
|
if tc.save {
|
||||||
|
got := waitPreauthInsert(t, c)
|
||||||
|
if got["TotalMinorUnits"] != "3100" || got["TxnReference"] != "preauth-ref" {
|
||||||
|
t.Errorf("persisted=%v, want provider amount/reference", got)
|
||||||
|
}
|
||||||
|
departure := time.Date(2026, 9, 11, 0, 0, 0, 0, time.Local).UTC()
|
||||||
|
if got["DepartureDate"] != departure || got["ReleaseDate"] != departure.Add(48*time.Hour) {
|
||||||
|
t.Errorf("persisted dates=%v, want existing local midnight plus 48 hours", got)
|
||||||
|
}
|
||||||
|
} else if c.count.Load() != 0 {
|
||||||
|
t.Error("non-persisting result inserted SQL")
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func preauthStreamRequest(amount, kind, checkout string) *http.Request {
|
||||||
|
body, _ := json.Marshal(creditCallPreauthRequest{Amount: amount, TransactionType: kind, CheckoutDate: checkout})
|
||||||
|
r := httptest.NewRequest(http.MethodPost, "/api/payment/preauth", strings.NewReader(string(body)))
|
||||||
|
r.Header.Set("Content-Type", "application/json")
|
||||||
|
return r
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCreditCallPreauthStreamingParity(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name, result, kind, total string
|
||||||
|
approved, persist bool
|
||||||
|
}{
|
||||||
|
{"monetary", "APPROVED", "SALE", "3100", true, true},
|
||||||
|
{"verification", "APPROVED", "ACCOUNT VERIFICATION", "", true, false},
|
||||||
|
{"declined", "DECLINED", "SALE", "", false, false},
|
||||||
|
{"verification failed", "DECLINED", "ACCOUNT VERIFICATION", "", false, false},
|
||||||
|
{"unknown approved type", "APPROVED", "AccountVerification", "", false, false},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
fields := map[string]string{types.TransactionResult: tc.result, types.TransactionType: tc.kind, types.Reference: "preauth-ref", types.PanMasked: "************1133", types.CardType: "Visa", types.ExpiryDate: "1228", types.CardHash: "hash", types.CardReference: "cardref", types.ReceiptDataCardholder: "receipt"}
|
||||||
|
if tc.total != "" {
|
||||||
|
fields[types.TotalAmount] = tc.total
|
||||||
|
}
|
||||||
|
amount, kind, date := "12000", "Sale", "2026-09-11 00:00:00 +0000"
|
||||||
|
if strings.Contains(tc.name, "verification") {
|
||||||
|
amount, kind, date = "", "AccountVerification", ""
|
||||||
|
}
|
||||||
|
var legacy cmstypes.ResponseRec
|
||||||
|
for _, stream := range []bool{false, true} {
|
||||||
|
calls, prints := 0, 0
|
||||||
|
app := newCreditCallTestApp(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
calls++
|
||||||
|
if stream {
|
||||||
|
if r.URL.Path != "/start-transaction-stream/" {
|
||||||
|
t.Errorf("stream called %s, want one generic start", r.URL.Path)
|
||||||
|
}
|
||||||
|
var input creditCallPreauthRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&input); err != nil {
|
||||||
|
t.Error(err)
|
||||||
|
}
|
||||||
|
if input.Amount != amount || input.TransactionType != kind {
|
||||||
|
t.Errorf("upstream input=%+v, want %q/%q", input, amount, kind)
|
||||||
|
}
|
||||||
|
for _, event := range []struct{ source, value string }{{"UPDATE", "CardRequested"}, {"CARD_STATUS", "Inserted"}, {"UPDATE", "CardRemovalRequested"}, {"CARD_STATUS", "Removed"}, {"UPDATE", "CardRequested"}, {"UPDATE", "CardRemovalEnforced"}, {"UPDATE", "PinEntryStarted"}, {"UPDATE", "OnlineAuthCompleted"}} {
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{"type": "status", "source": event.source, "value": event.value})
|
||||||
|
}
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{"type": "result", "result": fields})
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{"type": "result", "result": fields})
|
||||||
|
} else {
|
||||||
|
io.WriteString(w, chipDNAFixture(t, fields))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
c := preauthTestDatabase(t, app)
|
||||||
|
app.creditCallReceipt = func(receipt string) {
|
||||||
|
prints++
|
||||||
|
if receipt != "receipt" {
|
||||||
|
t.Errorf("receipt=%q, want retained receipt", receipt)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
recorder := httptest.NewRecorder()
|
||||||
|
if stream {
|
||||||
|
app.streamCreditCallPreauth(recorder, preauthStreamRequest(amount, kind, date))
|
||||||
|
frames := decodePaymentStream(t, recorder.Body)
|
||||||
|
var statuses []string
|
||||||
|
for _, frame := range frames {
|
||||||
|
if frame.Type == "status" {
|
||||||
|
statuses = append(statuses, frame.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
want := []string{paymentstatus.PresentCard, paymentstatus.DoNotRemoveCard, paymentstatus.RemoveCard, paymentstatus.PresentCard, paymentstatus.RemoveCard, paymentstatus.EnterPIN, paymentstatus.PleaseWait}
|
||||||
|
if !reflect.DeepEqual(statuses, want) {
|
||||||
|
t.Errorf("preauth statuses=%v, want %v", statuses, want)
|
||||||
|
}
|
||||||
|
final := frames[len(frames)-1].Result
|
||||||
|
if final == nil {
|
||||||
|
t.Fatal("missing structured final")
|
||||||
|
}
|
||||||
|
if (final.Outcome == "approved") != tc.approved || final.Status != legacy.Status || final.HTTPStatus != 200 {
|
||||||
|
t.Errorf("stream final=%+v, legacy=%+v", final, legacy)
|
||||||
|
}
|
||||||
|
if tc.approved && (final.TransactionReference != "preauth-ref" || final.CardType != "Visa" || final.MaskedCardNumber != "************1133" || final.ExpiryDate != "1228" || final.CardHash != "hash" || final.CardReference != "cardref") {
|
||||||
|
t.Errorf("preauth fields lost: %+v", final)
|
||||||
|
}
|
||||||
|
if len(frames) != len(want)+1 {
|
||||||
|
t.Errorf("frames=%d, want one final", len(frames))
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
app.takePreauthorization(recorder, preauthLegacyRequest(amount, kind, date))
|
||||||
|
if err := json.Unmarshal(recorder.Body.Bytes(), &legacy); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if calls != 1 || prints != 1 {
|
||||||
|
t.Errorf("calls/prints=%d/%d, want 1/1", calls, prints)
|
||||||
|
}
|
||||||
|
if tc.persist {
|
||||||
|
got := waitPreauthInsert(t, c)
|
||||||
|
if got["TotalMinorUnits"] != tc.total {
|
||||||
|
t.Errorf("SQL amount=%v, want provider %q", got["TotalMinorUnits"], tc.total)
|
||||||
|
}
|
||||||
|
} else if c.count.Load() != 0 {
|
||||||
|
t.Error("verification/failure persisted")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCreditCallInboundCancellationAfterDispatch(t *testing.T) {
|
||||||
|
for _, preauth := range []bool{false, true} {
|
||||||
|
t.Run(map[bool]string{false: "sale", true: "preauth"}[preauth], func(t *testing.T) {
|
||||||
|
dispatched := make(chan struct{})
|
||||||
|
release := make(chan struct{})
|
||||||
|
var starts, confirms, receipts atomic.Int32
|
||||||
|
app := newCreditCallTestApp(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path == "/confirm-transaction/" {
|
||||||
|
confirms.Add(1)
|
||||||
|
io.WriteString(w, chipDNAFixture(t, map[string]string{types.TransactionResult: "APPROVED", types.ReceiptDataCardholder: "receipt"}))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
starts.Add(1)
|
||||||
|
close(dispatched)
|
||||||
|
<-release
|
||||||
|
if r.Context().Err() != nil {
|
||||||
|
t.Errorf("financial upstream was cancelled: %v", r.Context().Err())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{"type": "result", "result": map[string]string{types.TransactionResult: "APPROVED", types.TransactionType: "SALE", types.TotalAmount: "3100", types.Reference: "delayed-ref", types.ReceiptDataCardholder: "receipt"}})
|
||||||
|
})
|
||||||
|
c := preauthTestDatabase(t, app)
|
||||||
|
app.creditCallReceipt = func(receipt string) {
|
||||||
|
if receipt != "receipt" {
|
||||||
|
t.Errorf("receipt=%q", receipt)
|
||||||
|
}
|
||||||
|
receipts.Add(1)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
defer cancel()
|
||||||
|
recorder := httptest.NewRecorder()
|
||||||
|
done := make(chan struct{})
|
||||||
|
go func() {
|
||||||
|
defer close(done)
|
||||||
|
if preauth {
|
||||||
|
app.streamCreditCallPreauth(recorder, preauthStreamRequest("12000", "Sale", "2026-09-11 00:00:00 +0000").WithContext(ctx))
|
||||||
|
} else {
|
||||||
|
app.streamCreditCallSale(recorder, saleRequest(true).WithContext(ctx))
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
select {
|
||||||
|
case <-dispatched:
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
close(release)
|
||||||
|
t.Fatal("no upstream dispatch")
|
||||||
|
}
|
||||||
|
cancel() // Exact acceptance boundary: upstream has observed StartTransaction.
|
||||||
|
close(release)
|
||||||
|
select {
|
||||||
|
case <-done:
|
||||||
|
case <-time.After(3 * time.Second):
|
||||||
|
t.Fatal("cancelled inbound request stopped finalization")
|
||||||
|
}
|
||||||
|
wantConfirms := int32(1)
|
||||||
|
if preauth {
|
||||||
|
wantConfirms = 0
|
||||||
|
got := waitPreauthInsert(t, c)
|
||||||
|
if got["TotalMinorUnits"] != "3100" {
|
||||||
|
t.Errorf("delayed persistence=%v", got)
|
||||||
|
}
|
||||||
|
if c.count.Load() != 1 {
|
||||||
|
t.Errorf("delayed persistence count=%d, want exactly one", c.count.Load())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if starts.Load() != 1 || receipts.Load() != 1 || confirms.Load() != wantConfirms {
|
||||||
|
t.Errorf("starts/receipts/confirms=%d/%d/%d, want 1/1/%d", starts.Load(), receipts.Load(), confirms.Load(), wantConfirms)
|
||||||
|
}
|
||||||
|
if recorder.Body.Len() != 0 {
|
||||||
|
t.Errorf("cancelled delivery wrote %s", recorder.Body.String())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCreditCallPreauthMissingAmountNeverSynthesized(t *testing.T) {
|
||||||
|
app := newCreditCallTestApp(t, func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
json.NewEncoder(w).Encode(map[string]any{"type": "result", "result": map[string]string{types.TransactionResult: "APPROVED", types.TransactionType: "SALE", types.Reference: "missing-amount"}})
|
||||||
|
})
|
||||||
|
c := preauthTestDatabase(t, app)
|
||||||
|
app.creditCallReceipt = func(string) {}
|
||||||
|
recorder := httptest.NewRecorder()
|
||||||
|
app.streamCreditCallPreauth(recorder, preauthStreamRequest("9999", "Sale", "2026-09-11 00:00:00 +0000"))
|
||||||
|
frames := decodePaymentStream(t, recorder.Body)
|
||||||
|
if frames[0].Result.Outcome != "approved" {
|
||||||
|
t.Fatalf("missing amount changed approval: %+v", frames[0].Result)
|
||||||
|
}
|
||||||
|
deadline := time.Now().Add(3 * time.Second)
|
||||||
|
for {
|
||||||
|
data, err := os.ReadFile(app.spoolPath())
|
||||||
|
var record preauthSpoolRecord
|
||||||
|
if err == nil && json.Unmarshal(data, &record) == nil {
|
||||||
|
if _, ok := record.Fields[types.TotalAmount]; ok {
|
||||||
|
t.Errorf("spool fabricated amount: %v", record.Fields)
|
||||||
|
}
|
||||||
|
if record.CheckoutDate != "2026-09-11 00:00:00 +0000" {
|
||||||
|
t.Errorf("spool checkout=%q", record.CheckoutDate)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if time.Now().After(deadline) {
|
||||||
|
t.Fatal("missing provider amount did not retain existing spool fallback")
|
||||||
|
}
|
||||||
|
time.Sleep(time.Millisecond)
|
||||||
|
}
|
||||||
|
if c.count.Load() != 0 {
|
||||||
|
t.Error("SQL inserted fabricated amount")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestCreditCallPreauthStreamFailureAndCancelledBeforeDispatch(t *testing.T) {
|
||||||
|
for _, body := range []string{"", "{", "{}\n", "<xml/>\n", "{\"type\":\"result\",\"result\":{}}\n", "{\"type\":\"result\",\"result\":{\"TRANSACTION_RESULT\":\"APPROVED\"}}"} {
|
||||||
|
app := newCreditCallTestApp(t, func(w http.ResponseWriter, r *http.Request) { io.WriteString(w, body) })
|
||||||
|
calls := 0
|
||||||
|
transport := app.creditCallTransport
|
||||||
|
app.creditCallTransport = creditCallRoundTrip(func(r *http.Request) (*http.Response, error) { calls++; return transport.RoundTrip(r) })
|
||||||
|
app.creditCallReceipt = func(string) { t.Error("malformed stream printed receipt") }
|
||||||
|
recorder := httptest.NewRecorder()
|
||||||
|
app.streamCreditCallPreauth(recorder, preauthStreamRequest("", "AccountVerification", ""))
|
||||||
|
frames := decodePaymentStream(t, recorder.Body)
|
||||||
|
if calls != 1 || len(frames) != 1 || frames[0].Result.Outcome != "error" || frames[0].Result.HTTPStatus != 502 {
|
||||||
|
t.Errorf("invalid stream %q: calls=%d frames=%+v", body, calls, frames)
|
||||||
|
}
|
||||||
|
ctx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
app.streamCreditCallPreauth(httptest.NewRecorder(), preauthStreamRequest("", "AccountVerification", "").WithContext(ctx))
|
||||||
|
if calls != 1 {
|
||||||
|
t.Error("already-cancelled request dispatched a transaction")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -63,6 +63,10 @@ func (outcome creditCallSaleOutcome) streamResult() creditCallStreamResult {
|
|||||||
func (app *App) EnableCreditCallStreaming() { app.creditCallStreamEnabled = true }
|
func (app *App) EnableCreditCallStreaming() { app.creditCallStreamEnabled = true }
|
||||||
|
|
||||||
func (app *App) streamCreditCallSale(w http.ResponseWriter, r *http.Request) {
|
func (app *App) streamCreditCallSale(w http.ResponseWriter, r *http.Request) {
|
||||||
|
app.streamCreditCall(w, r, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (app *App) streamCreditCall(w http.ResponseWriter, r *http.Request, preauth bool) {
|
||||||
setPaymentCORS(w)
|
setPaymentCORS(w)
|
||||||
if r.Method == http.MethodOptions {
|
if r.Method == http.MethodOptions {
|
||||||
w.WriteHeader(http.StatusNoContent)
|
w.WriteHeader(http.StatusNoContent)
|
||||||
@@ -97,6 +101,10 @@ func (app *App) streamCreditCallSale(w http.ResponseWriter, r *http.Request) {
|
|||||||
w.WriteHeader(status)
|
w.WriteHeader(status)
|
||||||
send(paymentStreamMessage{Type: "result", Result: &result})
|
send(paymentStreamMessage{Type: "result", Result: &result})
|
||||||
}
|
}
|
||||||
|
if preauth && !app.creditCallStreamEnabled {
|
||||||
|
reject(http.StatusServiceUnavailable, "CreditCall preauthorization streaming is not enabled")
|
||||||
|
return
|
||||||
|
}
|
||||||
if !app.isPayment && !app.cfg.TestMode {
|
if !app.isPayment && !app.cfg.TestMode {
|
||||||
mail.SendEmailOnError(app.cfg.Hotel, app.cfg.Kiosk, "Payment Error", "Attempted payment while payment processing is disabled")
|
mail.SendEmailOnError(app.cfg.Hotel, app.cfg.Kiosk, "Payment Error", "Attempted payment while payment processing is disabled")
|
||||||
reject(http.StatusServiceUnavailable, "Payment processing is disabled")
|
reject(http.StatusServiceUnavailable, "Payment processing is disabled")
|
||||||
@@ -111,33 +119,53 @@ func (app *App) streamCreditCallSale(w http.ResponseWriter, r *http.Request) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
defer r.Body.Close()
|
defer r.Body.Close()
|
||||||
var request SalePaymentRequest
|
var transaction cmstypes.TransactionRec
|
||||||
if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
|
if preauth {
|
||||||
reject(http.StatusBadRequest, "Invalid JSON payload")
|
var request creditCallPreauthRequest
|
||||||
return
|
if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
|
||||||
}
|
reject(http.StatusBadRequest, "Invalid JSON payload")
|
||||||
if request.Amount <= 0 {
|
return
|
||||||
reject(http.StatusBadRequest, "Amount must be greater than zero")
|
}
|
||||||
return
|
transaction = cmstypes.TransactionRec{AmountMinorUnits: request.Amount, TransactionType: request.TransactionType, CheckoutDate: request.CheckoutDate}
|
||||||
|
} else {
|
||||||
|
var request SalePaymentRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&request); err != nil {
|
||||||
|
reject(http.StatusBadRequest, "Invalid JSON payload")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if request.Amount <= 0 {
|
||||||
|
reject(http.StatusBadRequest, "Amount must be greater than zero")
|
||||||
|
return
|
||||||
|
}
|
||||||
|
transaction = cmstypes.TransactionRec{AmountMinorUnits: strconv.FormatInt(request.Amount, 10), TransactionType: "Sale"}
|
||||||
}
|
}
|
||||||
if _, ok := w.(http.Flusher); !ok {
|
if _, ok := w.(http.Flusher); !ok {
|
||||||
reject(http.StatusInternalServerError, "Streaming payment updates are not supported")
|
reject(http.StatusInternalServerError, "Streaming payment updates are not supported")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Validation belongs to the incoming request. This handoff owns financial dispatch.
|
||||||
|
if r.Context().Err() != nil {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
financialContext := context.WithoutCancel(r.Context())
|
||||||
progress := make(chan string, 128)
|
progress := make(chan string, 128)
|
||||||
finished := make(chan creditCallSaleOutcome, 1)
|
finished := make(chan creditCallSaleOutcome, 1)
|
||||||
go func() {
|
go func() {
|
||||||
outcome := app.executeCreditCallSale(cmstypes.TransactionRec{
|
start := func(client *http.Client) (creditcall.TransactionResultXML, error) {
|
||||||
AmountMinorUnits: strconv.FormatInt(request.Amount, 10), TransactionType: "Sale",
|
return callChipDNATransactionStream(financialContext, client, transaction, func(code string) {
|
||||||
}, func(client *http.Client) (creditcall.TransactionResultXML, error) {
|
|
||||||
return callChipDNAStream(client, request.Amount, func(code string) {
|
|
||||||
select {
|
select {
|
||||||
case progress <- code:
|
case progress <- code:
|
||||||
default: // Observational progress may be dropped under backpressure.
|
default: // Observational progress may be dropped under backpressure.
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
})
|
}
|
||||||
|
var outcome creditCallSaleOutcome
|
||||||
|
if preauth {
|
||||||
|
outcome = app.executeCreditCallPreauth(financialContext, transaction, start)
|
||||||
|
} else {
|
||||||
|
outcome = app.executeCreditCallSale(transaction, start)
|
||||||
|
}
|
||||||
close(progress)
|
close(progress)
|
||||||
finished <- outcome // Independent of the bounded progress queue.
|
finished <- outcome // Independent of the bounded progress queue.
|
||||||
}()
|
}()
|
||||||
@@ -163,16 +191,22 @@ func (app *App) streamCreditCallSale(w http.ResponseWriter, r *http.Request) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func callChipDNAStream(client *http.Client, amount int64, onStatus func(string)) (creditcall.TransactionResultXML, error) {
|
func callChipDNAStream(client *http.Client, amount int64, onStatus func(string)) (creditcall.TransactionResultXML, error) {
|
||||||
|
return callChipDNATransactionStream(context.Background(), client, cmstypes.TransactionRec{
|
||||||
|
AmountMinorUnits: strconv.FormatInt(amount, 10), TransactionType: "Sale",
|
||||||
|
}, onStatus)
|
||||||
|
}
|
||||||
|
|
||||||
|
func callChipDNATransactionStream(ctx context.Context, client *http.Client, transaction cmstypes.TransactionRec, onStatus func(string)) (creditcall.TransactionResultXML, error) {
|
||||||
var result creditcall.TransactionResultXML
|
var result creditcall.TransactionResultXML
|
||||||
payload, err := json.Marshal(struct {
|
payload, err := json.Marshal(struct {
|
||||||
Amount string `json:"amount"`
|
Amount string `json:"amount"`
|
||||||
TransactionType string `json:"transactionType"`
|
TransactionType string `json:"transactionType"`
|
||||||
}{strconv.FormatInt(amount, 10), "Sale"})
|
}{transaction.AmountMinorUnits, transaction.TransactionType})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
// Background plus Client.Timeout reproduces the independent per-call bound.
|
// Dispatch owns ctx; Client.Timeout retains the independent 300-second call bound.
|
||||||
req, err := http.NewRequestWithContext(context.Background(), http.MethodPost, types.LinkStartTransactionStream, bytes.NewReader(payload))
|
req, err := http.NewRequestWithContext(ctx, http.MethodPost, types.LinkStartTransactionStream, bytes.NewReader(payload))
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return result, err
|
return result, err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -121,11 +121,11 @@ func TestIssueDoorCardPhysicalOutcomeContract(t *testing.T) {
|
|||||||
wantCardWell string
|
wantCardWell string
|
||||||
}{
|
}{
|
||||||
{
|
{
|
||||||
name: "initial dispenser preparation failure is unavailable",
|
name: "initial dispenser preparation failure is retryable",
|
||||||
dispenser: fakeDoorCardDispenser{
|
dispenser: fakeDoorCardDispenser{
|
||||||
prepareCurrent: dispenserCallResult{status: "Card jammed", err: errors.New("card jammed")},
|
prepareCurrent: dispenserCallResult{status: "Card jammed", err: errors.New("card jammed")},
|
||||||
},
|
},
|
||||||
wantHTTP: http.StatusServiceUnavailable,
|
wantHTTP: http.StatusBadGateway,
|
||||||
wantMessage: "Dispense error: card jammed",
|
wantMessage: "Dispense error: card jammed",
|
||||||
wantCalls: []string{"prepare current"},
|
wantCalls: []string{"prepare current"},
|
||||||
wantCardWell: "Card jammed",
|
wantCardWell: "Card jammed",
|
||||||
@@ -140,6 +140,13 @@ func TestIssueDoorCardPhysicalOutcomeContract(t *testing.T) {
|
|||||||
wantCalls: []string{"prepare current"},
|
wantCalls: []string{"prepare current"},
|
||||||
wantCardWell: "Card empty",
|
wantCardWell: "Card empty",
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
name: "exhausted preparation is retryable without encoding or delivery",
|
||||||
|
dispenser: fakeDoorCardDispenser{prepareCurrent: dispenserCallResult{err: errors.Join(errors.New("preparation"), dispenser.ErrPreparationExhausted)}},
|
||||||
|
wantHTTP: http.StatusBadGateway,
|
||||||
|
wantMessage: "preparation\ncard preparation exhausted",
|
||||||
|
wantCalls: []string{"prepare current"},
|
||||||
|
},
|
||||||
{
|
{
|
||||||
name: "encoding and accepted delivery command succeed",
|
name: "encoding and accepted delivery command succeed",
|
||||||
wantHTTP: http.StatusOK,
|
wantHTTP: http.StatusOK,
|
||||||
@@ -148,13 +155,13 @@ func TestIssueDoorCardPhysicalOutcomeContract(t *testing.T) {
|
|||||||
wantLockSequence: 1,
|
wantLockSequence: 1,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "successful encoding with delivery command failure is unavailable",
|
name: "successful encoding with delivery command failure still prestages and succeeds",
|
||||||
dispenser: fakeDoorCardDispenser{
|
dispenser: fakeDoorCardDispenser{
|
||||||
deliverCurrent: dispenserCallResult{status: "Card jammed", err: errors.New("delivery jammed")},
|
deliverCurrent: dispenserCallResult{status: "Card jammed", err: errors.New("delivery jammed")},
|
||||||
},
|
},
|
||||||
wantHTTP: http.StatusServiceUnavailable,
|
wantHTTP: http.StatusOK,
|
||||||
wantMessage: "Card delivery could not be confirmed",
|
wantMessage: "Card issued successfully",
|
||||||
wantCalls: []string{"prepare current", "deliver current"},
|
wantCalls: []string{"prepare current", "deliver current", "begin prepare next"},
|
||||||
wantLockSequence: 1,
|
wantLockSequence: 1,
|
||||||
wantCardWell: "Card jammed",
|
wantCardWell: "Card jammed",
|
||||||
},
|
},
|
||||||
@@ -169,36 +176,45 @@ func TestIssueDoorCardPhysicalOutcomeContract(t *testing.T) {
|
|||||||
wantLockSequence: 1,
|
wantLockSequence: 1,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "encoding failure with safe recovery remains retryable",
|
name: "delivery clearance deferral does not undo successful issuance",
|
||||||
lockErr: encodingErr,
|
dispenser: fakeDoorCardDispenser{
|
||||||
wantHTTP: http.StatusBadGateway,
|
beginNextErr: errors.New("next-card preparation deferred: previous delivery is not clear"),
|
||||||
wantMessage: encodingErr.Error(),
|
},
|
||||||
wantCalls: []string{"prepare current", "deliver current", "prepare next"},
|
wantHTTP: http.StatusOK,
|
||||||
|
wantMessage: "Card issued successfully",
|
||||||
|
wantCalls: []string{"prepare current", "deliver current", "begin prepare next"},
|
||||||
wantLockSequence: 1,
|
wantLockSequence: 1,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "encoding failure with failed-card delivery failure is unavailable",
|
name: "encoding failure ends after delivery",
|
||||||
|
lockErr: encodingErr,
|
||||||
|
wantHTTP: http.StatusBadGateway,
|
||||||
|
wantMessage: encodingErr.Error(),
|
||||||
|
wantCalls: []string{"prepare current", "deliver current"},
|
||||||
|
wantLockSequence: 1,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "encoding failure remains retryable despite FC0 failure",
|
||||||
dispenser: fakeDoorCardDispenser{
|
dispenser: fakeDoorCardDispenser{
|
||||||
deliverCurrent: dispenserCallResult{status: "Card jammed", err: errors.New("delivery jammed")},
|
deliverCurrent: dispenserCallResult{status: "Card jammed", err: errors.New("delivery jammed")},
|
||||||
},
|
},
|
||||||
lockErr: encodingErr,
|
lockErr: encodingErr,
|
||||||
wantHTTP: http.StatusServiceUnavailable,
|
wantHTTP: http.StatusBadGateway,
|
||||||
wantMessage: "Dispenser recovery failed; another encoding attempt is not safe",
|
wantMessage: encodingErr.Error(),
|
||||||
wantCalls: []string{"prepare current", "deliver current"},
|
wantCalls: []string{"prepare current", "deliver current"},
|
||||||
wantLockSequence: 1,
|
wantLockSequence: 1,
|
||||||
wantCardWell: "Card jammed",
|
wantCardWell: "Card jammed",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
name: "encoding failure with empty card well has stable message",
|
name: "encoding failure never prepares next card",
|
||||||
dispenser: fakeDoorCardDispenser{
|
dispenser: fakeDoorCardDispenser{
|
||||||
prepareNext: dispenserCallResult{status: "Card empty", err: dispenser.ErrCardWellEmpty},
|
prepareNext: dispenserCallResult{status: "Card empty", err: dispenser.ErrCardWellEmpty},
|
||||||
},
|
},
|
||||||
lockErr: encodingErr,
|
lockErr: encodingErr,
|
||||||
wantHTTP: http.StatusServiceUnavailable,
|
wantHTTP: http.StatusBadGateway,
|
||||||
wantMessage: dispenser.CardWellEmptyMessage,
|
wantMessage: encodingErr.Error(),
|
||||||
wantCalls: []string{"prepare current", "deliver current", "prepare next"},
|
wantCalls: []string{"prepare current", "deliver current"},
|
||||||
wantLockSequence: 1,
|
wantLockSequence: 1,
|
||||||
wantCardWell: "Card empty",
|
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -311,3 +327,53 @@ func TestIssueDoorCardLogsNextCardDispatchFailureAndStillSucceeds(t *testing.T)
|
|||||||
t.Fatalf("dispatch failure log = %q", logged)
|
t.Fatalf("dispatch failure log = %q", logged)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestIssueDoorCardLogsDeliveryFailureWithoutReplacingEncoderOutcome(t *testing.T) {
|
||||||
|
for _, encodingErr := range []error{nil, errors.New("original encoder failure")} {
|
||||||
|
var output bytes.Buffer
|
||||||
|
logger := log.StandardLogger()
|
||||||
|
previous := logger.Out
|
||||||
|
logger.SetOutput(&output)
|
||||||
|
d := &fakeDoorCardDispenser{deliverCurrent: dispenserCallResult{err: errors.New("FC0 dispatch failed")}}
|
||||||
|
lock := &fakeDoorCardLockServer{sequenceErr: encodingErr}
|
||||||
|
recorder, response, _ := performIssueDoorCardRequest(t, d, lock)
|
||||||
|
logger.SetOutput(previous)
|
||||||
|
wantHTTP := http.StatusOK
|
||||||
|
if encodingErr != nil {
|
||||||
|
wantHTTP = http.StatusBadGateway
|
||||||
|
}
|
||||||
|
if recorder.Code != wantHTTP {
|
||||||
|
t.Errorf("issueDoorCard(%v) HTTP = %d, want %d", encodingErr, recorder.Code, wantHTTP)
|
||||||
|
}
|
||||||
|
if encodingErr != nil && response.Message != encodingErr.Error() {
|
||||||
|
t.Errorf("issueDoorCard message = %q, want %q", response.Message, encodingErr.Error())
|
||||||
|
}
|
||||||
|
if !strings.Contains(output.String(), "FC0 dispatch failed") || !strings.Contains(output.String(), "Card delivery") {
|
||||||
|
t.Errorf("issueDoorCard delivery log = %q, want FC0 failure and Card delivery", output.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestIssueDoorCardOnlyEmptyPreparationReturns503(t *testing.T) {
|
||||||
|
for _, failure := range []error{
|
||||||
|
dispenser.ErrCardWellEmpty, errors.Join(errors.New("wrapped"), dispenser.ErrCardWellEmpty),
|
||||||
|
dispenser.ErrPreparationExhausted, context.Canceled, context.DeadlineExceeded,
|
||||||
|
errors.New("malformed AP"), errors.New("truncated AP"), errors.New("no response"),
|
||||||
|
errors.New("serial read failed"), errors.New("serial write failed"), errors.New("FC7 dispatch failed"),
|
||||||
|
errors.New("RS dispatch failed"), errors.New(dispenser.CardWellEmptyMessage), errors.New("other preparation error"),
|
||||||
|
} {
|
||||||
|
d := &fakeDoorCardDispenser{prepareCurrent: dispenserCallResult{err: failure}}
|
||||||
|
lock := &fakeDoorCardLockServer{}
|
||||||
|
recorder, response, _ := performIssueDoorCardRequest(t, d, lock)
|
||||||
|
want := http.StatusBadGateway
|
||||||
|
if errors.Is(failure, dispenser.ErrCardWellEmpty) {
|
||||||
|
want = http.StatusServiceUnavailable
|
||||||
|
}
|
||||||
|
if recorder.Code != want || response.Code != want {
|
||||||
|
t.Errorf("preparation %v HTTP=%d body=%d, want %d", failure, recorder.Code, response.Code, want)
|
||||||
|
}
|
||||||
|
if lock.sequenceCalls != 0 || !reflect.DeepEqual(d.calls, []string{"prepare current"}) {
|
||||||
|
t.Errorf("preparation %v encoder=%d calls=%v, want no physical continuation", failure, lock.sequenceCalls, d.calls)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"encoding/xml"
|
"encoding/xml"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
@@ -78,6 +77,7 @@ func (app *App) RegisterRoutes(mux *http.ServeMux) {
|
|||||||
mux.HandleFunc("/ping-pdq", app.fetchChipDNAStatus)
|
mux.HandleFunc("/ping-pdq", app.fetchChipDNAStatus)
|
||||||
mux.HandleFunc("/logerror", app.onChipDNAError)
|
mux.HandleFunc("/logerror", app.onChipDNAError)
|
||||||
mux.HandleFunc("/api/payment/sale", app.salePayment)
|
mux.HandleFunc("/api/payment/sale", app.salePayment)
|
||||||
|
mux.HandleFunc("/api/payment/preauth", app.streamCreditCallPreauth)
|
||||||
}
|
}
|
||||||
|
|
||||||
func (app *App) takePreauthorization(w http.ResponseWriter, r *http.Request) {
|
func (app *App) takePreauthorization(w http.ResponseWriter, r *http.Request) {
|
||||||
@@ -86,9 +86,6 @@ func (app *App) takePreauthorization(w http.ResponseWriter, r *http.Request) {
|
|||||||
var (
|
var (
|
||||||
theResponse cmstypes.ResponseRec
|
theResponse cmstypes.ResponseRec
|
||||||
theRequest cmstypes.TransactionRec
|
theRequest cmstypes.TransactionRec
|
||||||
trResult creditcall.TransactionResultXML
|
|
||||||
result creditcall.PaymentResult
|
|
||||||
save bool
|
|
||||||
)
|
)
|
||||||
|
|
||||||
theResponse.Status.Code = http.StatusInternalServerError
|
theResponse.Status.Code = http.StatusInternalServerError
|
||||||
@@ -149,39 +146,18 @@ func (app *App) takePreauthorization(w http.ResponseWriter, r *http.Request) {
|
|||||||
theRequest.TransactionType,
|
theRequest.TransactionType,
|
||||||
)
|
)
|
||||||
|
|
||||||
client := app.creditCallClient()
|
outcome := app.executeCreditCallPreauth(context.Background(), theRequest, func(client *http.Client) (creditcall.TransactionResultXML, error) {
|
||||||
|
var transaction creditcall.TransactionResultXML
|
||||||
// ---- START TRANSACTION ----
|
response, err := callChipDNA(client, types.LinkStartTransaction, body)
|
||||||
|
if err != nil {
|
||||||
body, err = callChipDNA(client, types.LinkStartTransaction, body)
|
return transaction, err
|
||||||
if err != nil {
|
}
|
||||||
logging.Error(types.ServiceName, err.Error(), "Preauth processing error", string(op), "", "", 0)
|
if err := transaction.ParseTransactionResult(response); err != nil {
|
||||||
|
logging.Error(types.ServiceName, err.Error(), "Parse transaction result error", string(op), "", "", 0)
|
||||||
theResponse.Data = creditcall.BuildFailureURL(types.ResultError, "No response from payment processor")
|
}
|
||||||
writeTransactionResult(w, http.StatusBadGateway, theResponse)
|
return transaction, nil
|
||||||
return
|
})
|
||||||
}
|
writeTransactionResult(w, outcome.HTTPStatus, outcome.legacyResponse())
|
||||||
|
|
||||||
if err := trResult.ParseTransactionResult(body); err != nil {
|
|
||||||
logging.Error(types.ServiceName, err.Error(), "Parse transaction result error", string(op), "", "", 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
result.FillFromTransactionResult(trResult)
|
|
||||||
|
|
||||||
// ---- PRINT RECEIPT ----
|
|
||||||
|
|
||||||
app.printCreditCallReceipt(result.CardholderReceipt)
|
|
||||||
|
|
||||||
// ---- REDIRECT ----
|
|
||||||
|
|
||||||
theResponse.Status = result.Status
|
|
||||||
theResponse.Data, save = creditcall.BuildPreauthRedirectURL(result.Fields)
|
|
||||||
|
|
||||||
if save {
|
|
||||||
go app.persistPreauth(context.Background(), result.Fields, theRequest.CheckoutDate)
|
|
||||||
}
|
|
||||||
|
|
||||||
writeTransactionResult(w, http.StatusOK, theResponse)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (app *App) takePayment(w http.ResponseWriter, r *http.Request) {
|
func (app *App) takePayment(w http.ResponseWriter, r *http.Request) {
|
||||||
@@ -322,7 +298,11 @@ func (app *App) issueDoorCard(w http.ResponseWriter, r *http.Request) {
|
|||||||
errorhandlers.WriteError(w, http.StatusServiceUnavailable, dispenser.CardWellEmptyMessage)
|
errorhandlers.WriteError(w, http.StatusServiceUnavailable, dispenser.CardWellEmptyMessage)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
errorhandlers.WriteError(w, http.StatusServiceUnavailable, "Dispense error: "+err.Error())
|
if errors.Is(err, dispenser.ErrPreparationExhausted) {
|
||||||
|
errorhandlers.WriteError(w, http.StatusBadGateway, err.Error())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
errorhandlers.WriteError(w, http.StatusBadGateway, "Dispense error: "+err.Error())
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -330,8 +310,11 @@ func (app *App) issueDoorCard(w http.ResponseWriter, r *http.Request) {
|
|||||||
// build lock server command
|
// build lock server command
|
||||||
app.lockserver.BuildCommand(doorReq, checkIn, checkOut)
|
app.lockserver.BuildCommand(doorReq, checkIn, checkOut)
|
||||||
|
|
||||||
// lock server sequence
|
// Each request performs at most one encoder operation.
|
||||||
|
encodingStarted := time.Now()
|
||||||
|
log.Info("LockSequence started")
|
||||||
encodingErr := app.lockserver.LockSequence()
|
encodingErr := app.lockserver.LockSequence()
|
||||||
|
log.Infof("LockSequence finished; success=%t duration=%s", encodingErr == nil, time.Since(encodingStarted))
|
||||||
if encodingErr != nil {
|
if encodingErr != nil {
|
||||||
logging.Error(types.ServiceName, encodingErr.Error(), "Key encoding", string(op), "", "", 0)
|
logging.Error(types.ServiceName, encodingErr.Error(), "Key encoding", string(op), "", "", 0)
|
||||||
}
|
}
|
||||||
@@ -344,32 +327,10 @@ func (app *App) issueDoorCard(w http.ResponseWriter, r *http.Request) {
|
|||||||
status, deliveryErr := app.disp.DeliverCurrentCard(finalizeCtx)
|
status, deliveryErr := app.disp.DeliverCurrentCard(finalizeCtx)
|
||||||
app.SetCardWellStatus(status)
|
app.SetCardWellStatus(status)
|
||||||
if deliveryErr != nil {
|
if deliveryErr != nil {
|
||||||
if encodingErr != nil {
|
|
||||||
recoveryErr := fmt.Errorf("key encoding failed: %v; dispenser recovery failed: %w", encodingErr, deliveryErr)
|
|
||||||
logging.Error(types.ServiceName, recoveryErr.Error(), "Dispenser recovery", string(op), "", "", 0)
|
|
||||||
errorhandlers.WriteError(w, http.StatusServiceUnavailable, "Dispenser recovery failed; another encoding attempt is not safe")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
logging.Error(types.ServiceName, deliveryErr.Error(), "Card delivery", string(op), "", "", 0)
|
logging.Error(types.ServiceName, deliveryErr.Error(), "Card delivery", string(op), "", "", 0)
|
||||||
errorhandlers.WriteError(w, http.StatusServiceUnavailable, "Card delivery could not be confirmed")
|
|
||||||
return
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if encodingErr != nil {
|
if encodingErr != nil {
|
||||||
status, preparationErr := app.disp.PrepareNextCard(finalizeCtx)
|
// FC0 is attempted once; the next UI request owns all further preparation.
|
||||||
app.SetCardWellStatus(status)
|
|
||||||
if preparationErr != nil {
|
|
||||||
recoveryErr := fmt.Errorf("key encoding failed: %v; dispenser recovery failed: %w", encodingErr, preparationErr)
|
|
||||||
logging.Error(types.ServiceName, recoveryErr.Error(), "Dispenser recovery", string(op), "", "", 0)
|
|
||||||
if errors.Is(preparationErr, dispenser.ErrCardWellEmpty) {
|
|
||||||
errorhandlers.WriteError(w, http.StatusServiceUnavailable, dispenser.CardWellEmptyMessage)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
errorhandlers.WriteError(w, http.StatusServiceUnavailable, "Dispenser recovery failed; another encoding attempt is not safe")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
errorhandlers.WriteError(w, http.StatusBadGateway, encodingErr.Error())
|
errorhandlers.WriteError(w, http.StatusBadGateway, encodingErr.Error())
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|||||||
+157
-78
@@ -245,95 +245,174 @@ func printCardholderReceipt(cardholderReceipt string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// receiptColumns follows the existing 44-column normal-size text convention.
|
||||||
|
const receiptColumns = 44
|
||||||
|
|
||||||
func BuildCardholderReceipt(entries []ReceiptEntryXML) ([]byte, error) {
|
func BuildCardholderReceipt(entries []ReceiptEntryXML) ([]byte, error) {
|
||||||
var buf bytes.Buffer
|
var buf bytes.Buffer
|
||||||
|
rendered := make([]bool, len(entries))
|
||||||
|
take := func(id string) string {
|
||||||
|
for i, entry := range entries {
|
||||||
|
if !rendered[i] && entry.ReceiptEntryId == id && entry.Value != "" {
|
||||||
|
rendered[i] = true
|
||||||
|
return receiptEntryText(entry)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
write := func(b []byte) { buf.Write(b) }
|
// Set and restore only text state; leave printer setup and transport alone.
|
||||||
// writeStr := func(s string) { buf.WriteString(s) }
|
normal := func() { buf.Write([]byte{ESC, 'a', 0, ESC, 'E', BOLD_OFF, GS, '!', NORMAL_FONT}) }
|
||||||
writeln := func(s string) {
|
normal()
|
||||||
buf.WriteString(s)
|
hasRows, newSection := false, false
|
||||||
|
beginLine := func(center bool) {
|
||||||
|
if hasRows && newSection {
|
||||||
|
buf.WriteString(strings.Repeat("-", receiptColumns) + "\n")
|
||||||
|
}
|
||||||
|
hasRows, newSection = true, false
|
||||||
|
if center {
|
||||||
|
buf.Write([]byte{ESC, 'a', CENTER})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
text := func(value string, bold bool) {
|
||||||
|
if bold {
|
||||||
|
buf.Write([]byte{ESC, 'E', BOLD_ON})
|
||||||
|
}
|
||||||
|
buf.WriteString(value)
|
||||||
|
if bold {
|
||||||
|
buf.Write([]byte{ESC, 'E', BOLD_OFF})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
line := func(value string, bold, center bool) {
|
||||||
|
if value == "" {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
beginLine(center)
|
||||||
|
text(value, bold)
|
||||||
buf.WriteByte('\n')
|
buf.WriteByte('\n')
|
||||||
|
normal()
|
||||||
|
}
|
||||||
|
pair := func(left, right string, boldRight bool) {
|
||||||
|
if gap, fits := receiptPairGap(left, right); fits {
|
||||||
|
beginLine(false)
|
||||||
|
text(left+gap, false)
|
||||||
|
text(right, boldRight)
|
||||||
|
buf.WriteByte('\n')
|
||||||
|
normal()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
line(left, false, false)
|
||||||
|
line(right, boldRight, false)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Build a lookup map by ReceiptEntryId
|
line(take("Recipient"), true, true)
|
||||||
m := make(map[string]ReceiptEntryXML, len(entries))
|
line(take("MerchantName"), false, true)
|
||||||
for _, e := range entries {
|
newSection = true
|
||||||
m[e.ReceiptEntryId] = e
|
line(take("CardScheme"), false, false)
|
||||||
|
line(take("PanMasked"), false, false)
|
||||||
|
pair(take("Aid"), take("PanSequence"), false)
|
||||||
|
pair(take("TransactionSource"), take("TransactionType"), false)
|
||||||
|
newSection = true
|
||||||
|
// Align the provider amount without parsing or modifying its value.
|
||||||
|
for i, entry := range entries {
|
||||||
|
if entry.ReceiptEntryId == "TotalAmount" && entry.Value != "" {
|
||||||
|
rendered[i] = true
|
||||||
|
label := entry.Label
|
||||||
|
if label == "" {
|
||||||
|
label = "TOTAL"
|
||||||
|
}
|
||||||
|
label = strings.TrimSuffix(label, ":") + ":"
|
||||||
|
if gap, fits := receiptPairGap(label, entry.Value); fits {
|
||||||
|
line(label+gap+entry.Value, true, false)
|
||||||
|
} else {
|
||||||
|
line(receiptEntryText(entry), true, false)
|
||||||
|
}
|
||||||
|
break
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
pair(take("CardholderVerification"), take("TransactionResult"), true)
|
||||||
// Utility to center text
|
newSection = true
|
||||||
// center := func(s string) {
|
line(take("AuthCode"), false, false)
|
||||||
// write([]byte{ESC, 'a', CENTER})
|
line(take("AuthReference"), false, false)
|
||||||
// writeln(s)
|
line(take("TransactionSeqNumber"), false, false)
|
||||||
// write([]byte{ESC, 'a', 0})
|
pair(take("MerchantIdMasked"), take("TerminalIdMasked"), false)
|
||||||
// }
|
line(take("AuthDateTime"), false, false)
|
||||||
|
footer := take("RetentionMessage")
|
||||||
// Utility for bold lines
|
// Preserve every remaining occurrence, including unknown IDs, in provider order.
|
||||||
// boldOn := func() { write([]byte{GS, '!', WIDER_FONT}) }
|
for i, entry := range entries {
|
||||||
// boldOff := func() { write([]byte{GS, '!', NORMAL_FONT}) }
|
if !rendered[i] && entry.Value != "" {
|
||||||
|
line(receiptEntryText(entry), false, false)
|
||||||
// boldOn()
|
}
|
||||||
|
|
||||||
// 1) Header: CARDHOLDER COPY
|
|
||||||
writeln(m["Recipient"].Value)
|
|
||||||
// writeStr("\n\n")
|
|
||||||
// 2) Merchant name
|
|
||||||
writeln(m["MerchantName"].Value)
|
|
||||||
// writeStr("\n\n")
|
|
||||||
// 3) AID
|
|
||||||
writeln("AID: " + m["Aid"].Value)
|
|
||||||
|
|
||||||
// 4) Card scheme & pan
|
|
||||||
writeln(fmt.Sprintf("%s Card: %s", m["CardScheme"].Value, m["PanMasked"].Value))
|
|
||||||
|
|
||||||
// 5) PAN Seq No
|
|
||||||
writeln("PAN Seq No: " + m["PanSequence"].Value)
|
|
||||||
|
|
||||||
// 6) Transaction source
|
|
||||||
writeln(m["TransactionSource"].Value)
|
|
||||||
|
|
||||||
// 7) Transaction type (Sale/Account Verification)
|
|
||||||
writeln(m["TransactionType"].Value)
|
|
||||||
|
|
||||||
// 8) Total
|
|
||||||
// assuming value like "GBP1.50" — insert space after currency
|
|
||||||
total := m["TotalAmount"].Value
|
|
||||||
if !strings.HasPrefix(total, "GBP") && len(total) > 3 {
|
|
||||||
total = total[:3] + " " + total[3:]
|
|
||||||
}
|
}
|
||||||
writeln("TOTAL: " + total)
|
newSection = true
|
||||||
|
line(footer, false, true)
|
||||||
// 9) Cardholder verification
|
normal()
|
||||||
writeln(m["CardholderVerification"].Value)
|
buf.Write([]byte{ESC, 'd', 7})
|
||||||
|
buf.Write([]byte{GS, 'V', 1})
|
||||||
// 10) Approved/Declined
|
|
||||||
writeln(m["TransactionResult"].Value)
|
|
||||||
|
|
||||||
// 11) Auth code
|
|
||||||
writeln("Auth Code: " + m["AuthCode"].Value)
|
|
||||||
|
|
||||||
// 12) Reference
|
|
||||||
writeln("Ref: " + m["AuthReference"].Value)
|
|
||||||
|
|
||||||
// 13) Merchant & terminal IDs
|
|
||||||
writeln("MID: " + m["MerchantIdMasked"].Value)
|
|
||||||
writeln("TID: " + m["TerminalIdMasked"].Value)
|
|
||||||
|
|
||||||
// 14) Date/time
|
|
||||||
writeln(m["AuthDateTime"].Value)
|
|
||||||
|
|
||||||
// 15) Retention message
|
|
||||||
writeln(m["RetentionMessage"].Value)
|
|
||||||
|
|
||||||
// boldOff()
|
|
||||||
|
|
||||||
// finally feed & cut
|
|
||||||
write([]byte{ESC, 'd', 7}) // Feed 5 lines
|
|
||||||
write([]byte{GS, 'V', 1})
|
|
||||||
|
|
||||||
return buf.Bytes(), nil
|
return buf.Bytes(), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func receiptEntryText(entry ReceiptEntryXML) string {
|
||||||
|
label := entry.Label
|
||||||
|
if label == "" {
|
||||||
|
switch entry.ReceiptEntryId {
|
||||||
|
case "Recipient", "MerchantName", "CardScheme", "TransactionSource", "TransactionType",
|
||||||
|
"CardholderVerification", "TransactionResult", "AuthDateTime", "RetentionMessage":
|
||||||
|
return entry.Value
|
||||||
|
case "PanMasked":
|
||||||
|
label = "Card"
|
||||||
|
case "Aid":
|
||||||
|
label = "AID"
|
||||||
|
case "PanSequence":
|
||||||
|
label = "PAN Seq No"
|
||||||
|
case "TotalAmount":
|
||||||
|
label = "TOTAL"
|
||||||
|
case "AuthCode":
|
||||||
|
label = "Auth Code"
|
||||||
|
case "AuthReference":
|
||||||
|
label = "Ref"
|
||||||
|
case "TransactionSeqNumber":
|
||||||
|
label = "Transaction Seq. No"
|
||||||
|
case "MerchantIdMasked":
|
||||||
|
label = "MID"
|
||||||
|
case "TerminalIdMasked":
|
||||||
|
label = "TID"
|
||||||
|
default:
|
||||||
|
var readable strings.Builder
|
||||||
|
runes := []rune(entry.ReceiptEntryId)
|
||||||
|
for i, r := range runes {
|
||||||
|
if i > 0 && r >= 'A' && r <= 'Z' &&
|
||||||
|
((runes[i-1] >= 'a' && runes[i-1] <= 'z') ||
|
||||||
|
(i+1 < len(runes) && runes[i+1] >= 'a' && runes[i+1] <= 'z')) {
|
||||||
|
readable.WriteByte(' ')
|
||||||
|
}
|
||||||
|
if r == '_' || r == '-' {
|
||||||
|
r = ' '
|
||||||
|
}
|
||||||
|
readable.WriteRune(r)
|
||||||
|
}
|
||||||
|
label = strings.TrimSpace(readable.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if label == "" {
|
||||||
|
return entry.Value
|
||||||
|
}
|
||||||
|
return strings.TrimSuffix(label, ":") + ": " + entry.Value
|
||||||
|
}
|
||||||
|
|
||||||
|
func receiptPairGap(left, right string) (string, bool) {
|
||||||
|
if left == "" || right == "" || len(left)+2+len(right) > receiptColumns {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
// Only printable ASCII has a predictable single-column width here.
|
||||||
|
for _, r := range left + right {
|
||||||
|
if r < ' ' || r > '~' {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return strings.Repeat(" ", receiptColumns-len(left)-len(right)), true
|
||||||
|
}
|
||||||
|
|
||||||
func printLogo(path string) ([]byte, error) {
|
func printLogo(path string) ([]byte, error) {
|
||||||
const maxLogoWidth = 384
|
const maxLogoWidth = 384
|
||||||
f, err := os.Open(path)
|
f, err := os.Open(path)
|
||||||
|
|||||||
@@ -0,0 +1,280 @@
|
|||||||
|
package printer
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
type receiptTestChar struct {
|
||||||
|
value byte
|
||||||
|
center, bold bool
|
||||||
|
}
|
||||||
|
|
||||||
|
type receiptTestOutput struct {
|
||||||
|
lines []string
|
||||||
|
chars []receiptTestChar
|
||||||
|
feeds, cuts int
|
||||||
|
}
|
||||||
|
|
||||||
|
// readReceiptText understands only the commands emitted by this receipt builder.
|
||||||
|
func readReceiptText(t *testing.T, data []byte) receiptTestOutput {
|
||||||
|
t.Helper()
|
||||||
|
var out receiptTestOutput
|
||||||
|
var line strings.Builder
|
||||||
|
var center, bold bool
|
||||||
|
for i := 0; i < len(data); {
|
||||||
|
if data[i] == ESC || data[i] == GS {
|
||||||
|
if i+2 >= len(data) {
|
||||||
|
t.Fatalf("BuildCardholderReceipt control bytes = %v, want complete command", data[i:])
|
||||||
|
}
|
||||||
|
prefix, command, value := data[i], data[i+1], data[i+2]
|
||||||
|
switch {
|
||||||
|
case prefix == ESC && command == 'a':
|
||||||
|
if value != 0 && value != CENTER {
|
||||||
|
t.Errorf("receipt alignment = %d, want left or center", value)
|
||||||
|
}
|
||||||
|
center = value == CENTER
|
||||||
|
case prefix == ESC && command == 'E':
|
||||||
|
if value != BOLD_OFF && value != BOLD_ON {
|
||||||
|
t.Errorf("receipt bold = %d, want on or off", value)
|
||||||
|
}
|
||||||
|
bold = value == BOLD_ON
|
||||||
|
case prefix == GS && command == '!':
|
||||||
|
if value != NORMAL_FONT {
|
||||||
|
t.Errorf("receipt size = %d, want normal size", value)
|
||||||
|
}
|
||||||
|
case prefix == ESC && command == 'd':
|
||||||
|
out.feeds++
|
||||||
|
if value != 7 || center || bold || i != len(data)-6 {
|
||||||
|
t.Errorf("receipt feed = %d, center=%t bold=%t offset=%d, want final seven-line feed in normal state", value, center, bold, i)
|
||||||
|
}
|
||||||
|
case prefix == GS && command == 'V':
|
||||||
|
out.cuts++
|
||||||
|
if value != 1 || i != len(data)-3 {
|
||||||
|
t.Errorf("receipt cut = %d at %d, want final GS V 1", value, i)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
t.Fatalf("BuildCardholderReceipt command = %v, want supported text command", data[i:i+3])
|
||||||
|
}
|
||||||
|
i += 3
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if data[i] == '\n' {
|
||||||
|
out.lines = append(out.lines, line.String())
|
||||||
|
line.Reset()
|
||||||
|
} else {
|
||||||
|
line.WriteByte(data[i])
|
||||||
|
out.chars = append(out.chars, receiptTestChar{value: data[i], center: center, bold: bold})
|
||||||
|
}
|
||||||
|
i++
|
||||||
|
}
|
||||||
|
if line.Len() != 0 || center || bold || out.feeds != 1 || out.cuts != 1 {
|
||||||
|
t.Errorf("receipt termination: trailing=%q center=%t bold=%t feeds=%d cuts=%d, want normal state and one feed/cut", line.String(), center, bold, out.feeds, out.cuts)
|
||||||
|
}
|
||||||
|
return out
|
||||||
|
}
|
||||||
|
|
||||||
|
func buildReceiptText(t *testing.T, entries []ReceiptEntryXML) receiptTestOutput {
|
||||||
|
t.Helper()
|
||||||
|
before := append([]ReceiptEntryXML(nil), entries...)
|
||||||
|
data, err := BuildCardholderReceipt(entries)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("BuildCardholderReceipt(%v) error = %v, want nil", entries, err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(entries, before) {
|
||||||
|
t.Errorf("BuildCardholderReceipt input = %v, want unchanged %v", entries, before)
|
||||||
|
}
|
||||||
|
if !bytes.HasSuffix(data, []byte{ESC, 'd', 7, GS, 'V', 1}) {
|
||||||
|
t.Errorf("BuildCardholderReceipt suffix = %v, want unchanged feed/cut", data)
|
||||||
|
}
|
||||||
|
return readReceiptText(t, data)
|
||||||
|
}
|
||||||
|
|
||||||
|
func sampleReceipt(recipient string) []ReceiptEntryXML {
|
||||||
|
return []ReceiptEntryXML{
|
||||||
|
{ReceiptEntryId: "Recipient", Value: recipient},
|
||||||
|
{ReceiptEntryId: "MerchantName", Value: "Standard Test Merchant"},
|
||||||
|
{ReceiptEntryId: "Aid", Value: "A0000000031010", Label: "AID"},
|
||||||
|
{ReceiptEntryId: "CardScheme", Value: "VISA DEBIT"},
|
||||||
|
{ReceiptEntryId: "PanMasked", Value: "************1133", Label: "Card"},
|
||||||
|
{ReceiptEntryId: "PanSequence", Value: "01", Label: "PAN Seq No"},
|
||||||
|
{ReceiptEntryId: "TransactionSource", Value: "ICC"},
|
||||||
|
{ReceiptEntryId: "TransactionType", Value: "SALE"},
|
||||||
|
{ReceiptEntryId: "TotalAmount", Value: "GBP120.00", Label: "TOTAL"},
|
||||||
|
{ReceiptEntryId: "CardholderVerification", Value: "PIN VERIFIED"},
|
||||||
|
{ReceiptEntryId: "TransactionResult", Value: "APPROVED"},
|
||||||
|
{ReceiptEntryId: "AuthCode", Value: "D0A35D", Label: "Auth Code"},
|
||||||
|
{ReceiptEntryId: "AuthReference", Value: "ChipDNA-Sale-20260908144731", Label: "Ref"},
|
||||||
|
{ReceiptEntryId: "MerchantIdMasked", Value: "******7897", Label: "MID"},
|
||||||
|
{ReceiptEntryId: "TerminalIdMasked", Value: "****9508", Label: "TID"},
|
||||||
|
{ReceiptEntryId: "TransactionSeqNumber", Value: "00001059", Label: "Transaction Seq. No"},
|
||||||
|
{ReceiptEntryId: "AuthDateTime", Value: "08/09/2026 14:48:06"},
|
||||||
|
{ReceiptEntryId: "RetentionMessage", Value: "Please retain for your records"},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildCardholderReceiptCompleteLayout(t *testing.T) {
|
||||||
|
for _, recipient := range []string{"CARDHOLDER COPY", "MERCHANT COPY"} {
|
||||||
|
t.Run(recipient, func(t *testing.T) {
|
||||||
|
entries := sampleReceipt(recipient)
|
||||||
|
out := buildReceiptText(t, entries)
|
||||||
|
// Ignore padding used for left/right placement, not semantic row order.
|
||||||
|
var rows []string
|
||||||
|
for _, line := range out.lines {
|
||||||
|
rows = append(rows, strings.Join(strings.Fields(line), " "))
|
||||||
|
}
|
||||||
|
rule := strings.Repeat("-", 44)
|
||||||
|
want := []string{recipient, "Standard Test Merchant", rule, "VISA DEBIT", "Card: ************1133",
|
||||||
|
"AID: A0000000031010 PAN Seq No: 01", "ICC SALE", rule, "TOTAL: GBP120.00", "PIN VERIFIED APPROVED", rule,
|
||||||
|
"Auth Code: D0A35D", "Ref: ChipDNA-Sale-20260908144731", "Transaction Seq. No: 00001059",
|
||||||
|
"MID: ******7897 TID: ****9508", "08/09/2026 14:48:06", rule, "Please retain for your records"}
|
||||||
|
if !reflect.DeepEqual(rows, want) {
|
||||||
|
t.Errorf("BuildCardholderReceipt(%q) rows = %q, want %q", recipient, rows, want)
|
||||||
|
}
|
||||||
|
for _, entry := range entries {
|
||||||
|
if !strings.Contains(strings.Join(out.lines, "\n"), entry.Value) {
|
||||||
|
t.Errorf("BuildCardholderReceipt(%q) lost %s=%q", recipient, entry.ReceiptEntryId, entry.Value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for _, line := range out.lines {
|
||||||
|
if line == "" || len(line) > 44 {
|
||||||
|
t.Errorf("BuildCardholderReceipt(%q) row = %q, want compact nonempty row within 44 columns", recipient, line)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if len(out.lines) > 19 {
|
||||||
|
t.Errorf("BuildCardholderReceipt(%q) rows = %d, want representative receipt at most 19", recipient, len(out.lines))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildCardholderReceiptFormattingState(t *testing.T) {
|
||||||
|
out := buildReceiptText(t, sampleReceipt("CARDHOLDER COPY"))
|
||||||
|
var plain strings.Builder
|
||||||
|
for _, char := range out.chars {
|
||||||
|
plain.WriteByte(char.value)
|
||||||
|
}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
text string
|
||||||
|
center, bold bool
|
||||||
|
}{
|
||||||
|
{"CARDHOLDER COPY", true, true}, {"Standard Test Merchant", true, false},
|
||||||
|
{"VISA DEBIT", false, false}, {"TOTAL:", false, true}, {"GBP120.00", false, true},
|
||||||
|
{"PIN VERIFIED", false, false}, {"APPROVED", false, true}, {"Auth Code:", false, false},
|
||||||
|
{"Please retain for your records", true, false},
|
||||||
|
} {
|
||||||
|
start := strings.Index(plain.String(), tc.text)
|
||||||
|
if start < 0 {
|
||||||
|
t.Fatalf("receipt text lacks %q", tc.text)
|
||||||
|
}
|
||||||
|
for _, char := range out.chars[start : start+len(tc.text)] {
|
||||||
|
if char.center != tc.center || char.bold != tc.bold {
|
||||||
|
t.Errorf("receipt style for %q = center:%t bold:%t, want center:%t bold:%t", tc.text, char.center, char.bold, tc.center, tc.bold)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildCardholderReceiptMissingFields(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name string
|
||||||
|
entries []ReceiptEntryXML
|
||||||
|
want []string
|
||||||
|
}{
|
||||||
|
{name: "empty"},
|
||||||
|
{name: "empty values", entries: []ReceiptEntryXML{{ReceiptEntryId: "Aid", Label: "AID"}, {ReceiptEntryId: "Unknown", Label: "Unused"}}},
|
||||||
|
{name: "one partner", entries: []ReceiptEntryXML{{ReceiptEntryId: "PanSequence", Value: "02"}}, want: []string{"PAN Seq No: 02"}},
|
||||||
|
{name: "result only", entries: []ReceiptEntryXML{{ReceiptEntryId: "TransactionResult", Value: "DECLINED"}}, want: []string{"DECLINED"}},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
out := buildReceiptText(t, tc.entries)
|
||||||
|
if !reflect.DeepEqual(out.lines, tc.want) {
|
||||||
|
t.Errorf("BuildCardholderReceipt(%v) rows = %q, want %q", tc.entries, out.lines, tc.want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildCardholderReceiptPreservesRemainingEntries(t *testing.T) {
|
||||||
|
entries := []ReceiptEntryXML{
|
||||||
|
{ReceiptEntryId: "AuthCode", Value: ""},
|
||||||
|
{ReceiptEntryId: "FooBar", Value: "first-extra", Priority: "9"},
|
||||||
|
{ReceiptEntryId: "AuthCode", Value: "primary", Label: "Provider authorization"},
|
||||||
|
{ReceiptEntryId: "AuthCode", Value: "duplicate", Label: "Second authorization"},
|
||||||
|
{ReceiptEntryId: "FooBar", Value: "second-extra", Label: "Foo", Priority: "1"},
|
||||||
|
{ReceiptEntryId: "RetentionMessage", Value: "Retain this"},
|
||||||
|
{ReceiptEntryId: "RetentionMessage", Value: "Extra retention"},
|
||||||
|
{ReceiptEntryId: "HTTPCode", Value: "provider-code"},
|
||||||
|
{Value: "unlabelled-value"},
|
||||||
|
}
|
||||||
|
out := buildReceiptText(t, entries)
|
||||||
|
want := []string{"Provider authorization: primary", "Foo Bar: first-extra", "Second authorization: duplicate",
|
||||||
|
"Foo: second-extra", "Extra retention", "HTTP Code: provider-code", "unlabelled-value", strings.Repeat("-", 44), "Retain this"}
|
||||||
|
if !reflect.DeepEqual(out.lines, want) {
|
||||||
|
t.Errorf("BuildCardholderReceipt remaining rows = %q, want %q", out.lines, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildCardholderReceiptPairBoundaries(t *testing.T) {
|
||||||
|
for _, tc := range []struct {
|
||||||
|
name, left, right string
|
||||||
|
paired bool
|
||||||
|
}{
|
||||||
|
{"short", "ICC", "SALE", true},
|
||||||
|
{"exact width", strings.Repeat("L", 20), strings.Repeat("R", 22), true},
|
||||||
|
{"overflow", strings.Repeat("L", 21), strings.Repeat("R", 22), false},
|
||||||
|
{"unicode", "TAP \u00c9", "SALE", false},
|
||||||
|
{"multiline", "ICC\nFALLBACK", "SALE", false},
|
||||||
|
{"left missing", "", "SALE", false},
|
||||||
|
{"right missing", "ICC", "", false},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
out := buildReceiptText(t, []ReceiptEntryXML{{ReceiptEntryId: "TransactionSource", Value: tc.left}, {ReceiptEntryId: "TransactionType", Value: tc.right}})
|
||||||
|
var want []string
|
||||||
|
if tc.paired {
|
||||||
|
want = []string{tc.left + strings.Repeat(" ", 44-len(tc.left)-len(tc.right)) + tc.right}
|
||||||
|
} else {
|
||||||
|
if tc.left != "" {
|
||||||
|
want = append(want, strings.Split(tc.left, "\n")...)
|
||||||
|
}
|
||||||
|
if tc.right != "" {
|
||||||
|
want = append(want, tc.right)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(out.lines, want) {
|
||||||
|
t.Errorf("BuildCardholderReceipt pair(%q,%q) rows = %q, want %q", tc.left, tc.right, out.lines, want)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildCardholderReceiptLongValuesAndLabels(t *testing.T) {
|
||||||
|
ref := strings.Repeat("long-reference-", 8)
|
||||||
|
verify := "CONSUMER DEVICE VERIFICATION WITH ADDITIONAL PROVIDER TEXT"
|
||||||
|
out := buildReceiptText(t, []ReceiptEntryXML{
|
||||||
|
{ReceiptEntryId: "CardholderVerification", Value: verify},
|
||||||
|
{ReceiptEntryId: "TransactionResult", Value: "DECLINED"},
|
||||||
|
{ReceiptEntryId: "AuthReference", Label: "Provider reference:", Value: ref},
|
||||||
|
{ReceiptEntryId: "MerchantIdMasked", Label: strings.Repeat("Merchant", 6), Value: "******7897"},
|
||||||
|
{ReceiptEntryId: "TerminalIdMasked", Value: "****9508"},
|
||||||
|
})
|
||||||
|
want := []string{verify, "DECLINED", strings.Repeat("-", 44), "Provider reference: " + ref,
|
||||||
|
strings.Repeat("Merchant", 6) + ": ******7897", "TID: ****9508"}
|
||||||
|
if !reflect.DeepEqual(out.lines, want) {
|
||||||
|
t.Errorf("BuildCardholderReceipt long fields rows = %q, want %q", out.lines, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestBuildCardholderReceiptProviderAmounts(t *testing.T) {
|
||||||
|
for _, amount := range []string{"GBP120.00", "EUR 42,50", "USD1.23", "amount supplied verbatim", strings.Repeat("9", 50)} {
|
||||||
|
t.Run(amount, func(t *testing.T) {
|
||||||
|
out := buildReceiptText(t, []ReceiptEntryXML{{ReceiptEntryId: "TotalAmount", Label: "Provider total", Value: amount}})
|
||||||
|
if len(out.lines) != 1 || !strings.HasPrefix(out.lines[0], "Provider total:") || !strings.HasSuffix(out.lines[0], amount) {
|
||||||
|
t.Errorf("BuildCardholderReceipt amount(%q) rows = %q, want provider label and unchanged amount", amount, out.lines)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,6 +2,18 @@
|
|||||||
|
|
||||||
builtVersion is a const in main.go
|
builtVersion is a const in main.go
|
||||||
|
|
||||||
|
#### v2.1.0 - 28 September 2026
|
||||||
|
fix(dispenser): tolerate unusable AP observations during card preparation
|
||||||
|
|
||||||
|
#### v2.0.3 - 24 September 2026
|
||||||
|
fix(dispenser): recover stuck card preparation with reset
|
||||||
|
|
||||||
|
#### v2.0.2 - 22 September 2026
|
||||||
|
fix(dispenser): retry on transient prepare failure
|
||||||
|
|
||||||
|
#### v2.0.1 - 10 September 2026
|
||||||
|
feat: add CreditCall preauth streaming
|
||||||
|
|
||||||
#### v2.0.0 - 08 September 2026
|
#### v2.0.0 - 08 September 2026
|
||||||
feat: stream CreditCall payment progress and results
|
feat: stream CreditCall payment progress and results
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user