Add UUID to each video event

[wzieba]

Partially addresses #28

Description

This PR adds a new parameter: vsid (Video Start ID) to each new videostart event and the same ID to associated vheartbeat events.

Requirements

create (...) videostart id for each (...) videostart pixel. We also attach those ids to the heartbeats associated with the (...) videostart.
(...)
Each primary event gets a new value and all (...) vheartbeats share the corresponding id.

Internal source: p1696261199218709/1696235256.764549-slack-C0533SEJ82H

New payload

Click

Test

1. Install example app, open logcat
2. Tap on Track Video
3. Wait 30 seconds until you see [Parsely] POST Data {"events": (...) log. Copy the JSON part.
4. Wait another 30 seconds until another [Parsely] POST Data {"events": (...) log, copy it as well.
5. Check the copied logs:

• there should be one "action": "videostart" event, rest of them should be "action": "vheartbeat"
• every event from both logs should have "vsid" field with the same value

[ParaskP7]

👋 @wzieba !

I have reviewed and tested this PR as per the instructions, everything works as expected, good job! 🌟

---

I have left a suggestion (💡) and a minor (🔍) comment for you to consider. I am going to approve this PR anyway, since none is blocking. I am NOT going to merge this PR yet to give you some time to apply any of my suggestions. However, feel free to ignore them and merge the PR yourself.

[ParaskP7]

Suggestion (💡): Instead of explicitly using an extra .put(VIDEO_START_ID_KEY, uuid) call after the event is constructed and returned, wherever that might be required, and thus letting the caller decide the event's state, which can be prone to misusage, how about moving that logic with the buildEvent(...) method itself and avoid any such misusage?

@NonNull
    private Map<String, Object> buildEvent(
            String url,
            String urlRef,
            String action,
            ParselyMetadata metadata,
            Map<String, Object> extraData,
            @Nullable String uuid) {

        ...

        if (action.equals("videostart") || action.equals("vheartbeat")) {
            event.put(VIDEO_START_ID_KEY, uuid);
        }

        return event;
    }

FYI: I also think that doing this makes it more visible and explicit and only videostart and vheartbeat type of events can have an associated vsid attached to them.

PS: I understand that this is adding an extra parameter to the method, and that would have been better if a builder pattern would to be used, but I still think it is better than letting callers decide that after the fact, when the even is already created and returned by the buildEvent(...) method. 🤔

[wzieba]

Sure, I can do that 👍

I understand that this is adding an extra parameter to the method

That was my concern when deciding on approach here, but keeping all "bulding blocks" in buildEvent method is probably indeed better!

[ParaskP7]

Thanks for c058582 @wzieba , but I think you just missed removing this hbEvent.put(VIDEO_START_ID_KEY, uuid); bit here, right? 🤔

[wzieba]

Yes, thank you! 🙏