Codex voucher redemptions are not handled

[Tkael]

EDDI version in which issue is found

3.7.0

VoiceAttack version in which issue is found (as applicable)

N/A

Steps to reproduce

1. Redeem a voucher from a codex discovery

Expected

EDDI to provide a scripted response for the voucher redemption

Observed

The following is recorded in the log:

2020-07-08T21:42:32 [Warning] JournalMonitor:ParseJournalEntry Unhandled voucher type codex { "timestamp":"2020-07-08T21:42:32Z", "event":"RedeemVoucher", "Type":"codex", "Amount":50000, "Faction":"" }

Investigation

The "RedeemVoucher" journal entry includes a "Type" property. EDDI currently creates different "voucher redeemed" style events for each "Type" that it supports. It does not currently support a "codex" type and consequently the "codex" type is unhandled.

EDDI/JournalMonitor/JournalMonitor.cs

Lines 2731 to 2750 in f3570f2

	if (type == "bounty")
	{
	events.Add(new BountyRedeemedEvent(timestamp, rewards, amount, brokerpercentage) { raw = line, fromLoad = fromLogLoad });
	}
	else if (type == "CombatBond")
	{
	events.Add(new BondRedeemedEvent(timestamp, rewards, amount, brokerpercentage) { raw = line, fromLoad = fromLogLoad });
	}
	else if (type == "trade")
	{
	events.Add(new TradeVoucherRedeemedEvent(timestamp, rewards, amount, brokerpercentage) { raw = line, fromLoad = fromLogLoad });
	}
	else if (type == "settlement" || type == "scannable")
	{
	events.Add(new DataVoucherRedeemedEvent(timestamp, rewards, amount, brokerpercentage) { raw = line, fromLoad = fromLogLoad });
	}
	else
	{
	Logging.Warn("Unhandled voucher type " + type, line);
	}

We have several options to resolve this:

1. Fold the "codex" type into the already existing "Data voucher redeemed" event.
2. Create a separate and new Codex voucher redeemed event.
3. Consolidate all of the "voucher redeemed" style events into a single event and single script, controlling the variations on script output via a "type" property which would be included in the consolidated event.

[nepomuk16321]

Thank you for the hints and the opening of this little problem.
I think your number one is the easiest way to implement the codex voucher.

[Tkael]

@richardbuckle @Hoodathunk @GioVAX Are we in agreement that option 1 should be our approach?

[GioVAX]

#1 is indeed the easiest way to implement this, but it would not be consistent with the existing code structure.

If we have time, I'd go for #3.

[Tkael]

I think option 3 is my preference too (it'll be the cleanest overall and most of the current voucher redeemed scripts already follow similar patterns, but it's also the most disruptive).

[richardbuckle]

Let's step back and ask ourselves what is the use case of having different event types here?

I would say implement (1) right away and then maybe create another ticket to migrate to (3) if we decide that is what we want to do.

[Tkael]

That's just it - I don't really see the use case for having multiple fairly redundant events and swapping to a single event makes it easier to add new voucher redemption options if new voucher types are added in future updates.

[richardbuckle]

Very well. let's implement (1) and create another ticket to migrate to (3).

[Tkael]

Ticket for option 3 generated, #1980.