Fail to export the process instance modification record to Elasticsearch

[saig0]

Describe the bug

Since version 8.1.1, we can't export the process instance modification record to Elasticsearch anymore. This is a regression to the previous version 8.1.0.

In bug fix #10609, we updated the record. But we forgot to update the ES template.

If a process instance modification is applied then the ES exporter tries to export the record and fails. As a result, no other records can be exported anymore.

To Reproduce

1. Apply a process instance modification in Operate, for example, activate an element
2. Verify that the result of the modification is not shown in Operate and an error is logged for the Zeebe broker

Expected behavior

The ES exporter can export process instance modification records.

Log/Stacktrace

Full Stacktrace

<STACKTRACE>

Environment:

• OS:
• Zeebe Version: 8.1.1
• Configuration:

[npepinpe]

If we're now exporting everything, please update integration tests to test for all records - when we initially implemented it, we excluded some value types since not everything was exported to ES at the time.

See:

zeebe/exporters/elasticsearch-exporter/src/test/java/io/camunda/zeebe/exporter/TestSupport.java

Line 98 in 4c78141

static Stream<ValueType> provideValueTypes() {

[remcowesterhoud]

This apparently didn't catch this problem. Modification records are part of the list that's returned here.

[npepinpe]

Then my guess is it's with the protocol factory which does not generate the record in a way to trigger the bug =/

Here's the generated record which is successfully exported:

Record {
	position = 3552743155436431360, sourceRecordPosition = 9083559922611906560, key = 8109027450636607488, timestamp = 8681491361747835904, intent = MODIFIED, partitionId = -1661998771, recordType = EVENT, rejectionType = EXCEEDED_BATCH_RECORD_SIZE, rejectionReason = eyqzCVl, brokerVersion = fsloWtLbmPpwPPFPqSazPtulSTc, valueType = PROCESS_INSTANCE_MODIFICATION, value = ProcessInstanceModificationRecordValue {
		processInstanceKey = 6741987849931465728, terminateInstructions = [ProcessInstanceModificationTerminateInstructionValue {
			elementInstanceKey = 2218556850149659648
		}], activateInstructions = [ProcessInstanceModificationActivateInstructionValue {
			elementId = ssxvnJHpDqdxVCrAsTVYbcw, ancestorScopeKey = 5879138056778155008, variableInstructions = [ProcessInstanceModificationVariableInstructionValue {
				variables = {
					vMgnykrx = VZXKGxtSPsjDGyLuEgqf,
					myARHaopufojhhdxEhX = true,
					lAqLocFLjbEpOwFnSO = true
				}, elementId = JBHwgSMzJGN
			}, ProcessInstanceModificationVariableInstructionValue {
				variables = {
					LoNjVXzXZozi = tKxJBOZWDjmCBOsYqQKcpRRdCZWmrlf,
					XblGQPrpGRNtaqoOsvXpkJPjlaVS = qcCRXFrrOllhWhoHFgcFwPNDlmwCSS,
					HWxQqykAl = aaWC
				}, elementId = MxyLm
			}, ProcessInstanceModificationVariableInstructionValue {
				variables = {
					RoVkumpSXHEliDqEOohoIHEGjoAZbV = 6741987849931465728,
					z = algdeskKTeeseMpRh,
					PUmC = HsHGXZYxxqruICRIjgqe
				}, elementId = bbWAxABQrirug
			}, ProcessInstanceModificationVariableInstructionValue {
				variables = {
					ZjUUvFyqovCDEdxYfprLgSgzX = SnIavoDTjKsQWHnwVpsamZKouDTWhiO,
					RJScziQYpCZmBYwK = 2218556850149659648,
					diKOkYngwpXZWmKrDCmBXkfU = false
				}, elementId = IlWDhBfxRFAoPrUGDFlPDlH
			}]
		}, ProcessInstanceModificationActivateInstructionValue {
			elementId = xxCxcuplWgDPPHemjGMtVmfqQF, ancestorScopeKey = 5076885281052073984, variableInstructions = []
		}, ProcessInstanceModificationActivateInstructionValue {
			elementId = vCupOFYWlDUeBICkpZKhkVMcjvW, ancestorScopeKey = 5511382405989329920, variableInstructions = [ProcessInstanceModificationVariableInstructionValue {
				variables = {
					uRfBO = rJL,
					bPcbiwtSjNPrBnittKjywAhwgkZYnus = FIsPiYpIOgaUPZDxhcfVgxg,
					VktXBKapwApEnuezN = wnwdCAcDRLpIPHjQqkmofdqspKKn
				}, elementId = ivVCpFHIxAACZxZlfDmooSS
			}, ProcessInstanceModificationVariableInstructionValue {
				variables = {
					s = 5076885281052073984,
					ntkuP = 5879138056778155008,
					jQEirrQAmUCTBLb = true
				}, elementId = VPD
			}, ProcessInstanceModificationVariableInstructionValue {
				variables = {
					JtvhdcieGTa = VMyzoCIVskUNSmxEKbEWNZPrPwp,
					uJaBjxNqboxsHoeGmJSNbuTGTIfvEqp = SYbdXeXORpqDdoDzgBElOiStrwx,
					dYOIHAOoDZN = true
				}, elementId = meyWVVHGmJKWljCchPk
			}]
		}, ProcessInstanceModificationActivateInstructionValue {
			elementId = aFRASZ, ancestorScopeKey = 3073397267898435584, variableInstructions = []
		}]
	}
}

[npepinpe]

Ah, activatedElementInstanceKeys is not part of the API. If it's not part of the API, should it be exported, or should it be ignored in the template (but maybe part of the source)?

[remcowesterhoud]

I agree, ignoring it makes sense. It's only used internally

[npepinpe]

On thing we could do to keep serialization on par with the API, is instead of using toJson, use a specific writer for the value type, e.g. new ObjectMapper().writerFor(ProcessInstanceModificationRecordValue.class).writeValueAsString(myRecord). This will ignore properties not on the interface type (assuming this is what we want ofc).