Add full event as base 64 encoded X-Islandora-Event header

[seth-shaw-asu]

GitHub Issue: Event RFD (0000)

What does this Pull Request do?

Add the complete event JSON as an X-Islandora-Event HTTP header when calling microservices

• Serialize the full event payload to JSON
• Base64 encode if needed to handle special characters
• Include as additional header alongside existing parameters

How should this be tested?

🤷‍♂️ - throwing this up here for now; but I'm guessing we need to

1. Deploy it
2. Create a microservice that will read out the new header and dump it so we can see that it came through
3. Add an event to the queue for the new service so Alpaca picks it up and shuttles the event along.

The resulting alpaca build is too big for GitHub to permit me to attach it here. So, to build it yourself only using docker (no Java or Gradle required): docker run --rm -v "$(pwd):/app" -w /app eclipse-temurin:11 ./gradlew --stacktrace clean build shadowJar --no-daemon.

The resulting Jar file you need will be @ islandora-alpaca-app/build/libs/islandora-alpaca-*-all.jar

Interested parties

@Islandora/committers, esp @joecorall

[joecorall]

relates to Islandora-Labs/rfds#1

[whikloj]

Wondering if it might be easier to add the X-Islandora-Event header in Drupal and just have Alpaca pass it along? Especially if you are planning to stop using Alpaca anyways.

[joecorall]

@whikloj - do you see something wrong with the proposed changes in this PR? The change here seem small enough I think since the work is mostly done the clearest path may be to merge this PR after it's tested successfully.

[whikloj]

I don't see anything wrong specifically, you might want a try {} catch in case something goes haywire to add some logging and still send the message along. I haven't tested it though. I just mentioned this as it was my understanding is this is the first step in a process of moving away from ActiveMQ and Camel to everything in Drupal. So if Alpaca is going away, and this message will be needed in future anyways, why not send it directly from Drupal.

[joecorall]

So if Alpaca is going away, and this message will be needed in future anyways, why not send it directly from Drupal

It's just a bit of pragmatism. Right now changing alpaca will allow this new class of microservices that need this data to work for everyone. If we sent this new header from Drupal we'd need some other way to propogate the header to the respective microservice rather than going through the current happy path of drupal->activemq->alpaca->microservice.

[joecorall]

I had to make a change to this PR. One of the new class of microservices that rely on X-Islandora-Event (namely mergepdf) does not have an attachment (i.e. a source file) so those event attributes need to be optional 7119725

[whikloj]

I know this isnt the right place for this but I am looking to alter our tesseract actor to build hOCR and OCR at the same time. Perhaps we need a specification for the messages we are sending, then it would be easier to ensure all clients (I.e. Alpaca, etc) can handle all cases.

[adam-vessey]

Couple of tiny coding standards things.

[joecorall]

@whikloj I know this isnt the right place for this but I am looking to alter our tesseract actor to build hOCR and OCR at the same time. Perhaps we need a specification for the messages we are sending, then it would be easier to ensure all clients (I.e. Alpaca, etc) can handle all cases.

Let's have this conversation in Islandora-Labs/rfds#1

[aOelschlager]

I tested this pr with Joe's buildkit pr and it works! I was able to generate derivatives including the merge pdf derivatives.