[services] Tunnelbroker - Introduce `validateUUIDv4` function
ClosedPublic
Actions

Authored by • max on Jul 7 2022, 4:33 AM.

Details

Reviewers

• karol
tomek

Commits

rCOMMba74e714a19f: [services] Tunnelbroker - Introduce `validateUUIDv4` function

Summary

This diff introduces validateUUIDv4 function that checks the validity of the generated UUIDs based on the regular expression.

Related linear task: ENG-1360

Test Plan

Tests from D4468

Diff Detail

Repository

rCOMM Comm

Branch

add-validateuuid-function

Lint

No Lint Coverage

Unit

No Test Coverage

Event Timeline

• max created this revision.Jul 7 2022, 4:33 AM

• max held this revision as a draft.

Herald added subscribers: • abosh, • karol, atul and 3 others. · View Herald TranscriptJul 7 2022, 4:33 AM

Harbormaster completed remote builds in B10341: Diff 14249.Jul 7 2022, 4:47 AM

• max edited the summary of this revision. (Show Details)Jul 7 2022, 4:50 AM

• max mentioned this in D4468: [services] Tunnelbroker - Tests for `validateUUIDv4` function.Jul 7 2022, 4:55 AM

• max published this revision for review.Jul 7 2022, 4:57 AM

• max edited the summary of this revision. (Show Details)

• max edited the test plan for this revision. (Show Details)

• max added reviewers: • karol, tomek.

• max added a child revision: D4468: [services] Tunnelbroker - Tests for `validateUUIDv4` function.Jul 7 2022, 5:05 AM

• karol added inline comments.Jul 7 2022, 6:07 AM

services/lib/src/GlobalTools.cpp
50 ↗	(On Diff #14249)	can you provide a source of this regex?

• max marked an inline comment as done.Jul 7 2022, 6:24 AM

• max added inline comments.

services/lib/src/GlobalTools.cpp
50 ↗	(On Diff #14249)	can you provide a source of this regex? This expression is based on the UUID v4 format.

Why do we need to validate if it is formatted correctly? What could happen if we don't do that?

services/lib/src/GlobalTools.cpp
48 ↗	(On Diff #14249)	We need to state that we validate only v4
50 ↗	(On Diff #14249)

This revision is now accepted and ready to land.Jul 8 2022, 2:18 AM

The function name was changed to validateUUIDv4, small regexp simplify.

• max retitled this revision from [services] Tunnelbroker - Introduce `validateUUID` function to [services] Tunnelbroker - Introduce `validateUUIDv4` function.Jul 12 2022, 4:11 PM

• max edited the summary of this revision. (Show Details)

Harbormaster completed remote builds in B10469: Diff 14416.Jul 12 2022, 4:24 PM

In D4467#127455, @palys-swm wrote:

Why do we need to validate if it is formatted correctly?

In a recent message checkpointing architecture update, the messageID (UUID) is generated on the client-side. That's why we should check the messageID format validity received from the client.

What could happen if we don't do that?

Message IDs format would go wrong in the database and can cause a possible message collision in the deviceID messages batch.
At the moment we are checking the messageID for not being empty only. This function would be used instead of this simple check.

services/lib/src/GlobalTools.cpp
48 ↗	(On Diff #14249)	We need to state that we validate only v4 That makes sense, I've changed the function name.

Regular expression was changed to match lowercase only and case insensitive was removed from regex. The function now returns true
only for UUIDs in a lower case.

Harbormaster completed remote builds in B10470: Diff 14417.Jul 12 2022, 4:59 PM

Closed by commit rCOMMba74e714a19f: [services] Tunnelbroker - Introduce `validateUUIDv4` function (authored by • max). · Explain WhyJul 15 2022, 8:21 AM

This revision was automatically updated to reflect the committed changes.

• max added a commit: rCOMMba74e714a19f: [services] Tunnelbroker - Introduce `validateUUIDv4` function.

• max mentioned this in rCOMM8c0a660c8382: [services] Tunnelbroker - Tests for `validateUUIDv4` function.Jul 15 2022, 8:24 AM