Skip to content
This repository has been archived by the owner on Jul 13, 2023. It is now read-only.

Docs: Update docs to reflect normalized UUID #392

Closed
jrconlin opened this issue Mar 8, 2016 · 1 comment
Closed

Docs: Update docs to reflect normalized UUID #392

jrconlin opened this issue Mar 8, 2016 · 1 comment
Assignees

Comments

@jrconlin
Copy link
Member

jrconlin commented Mar 8, 2016

All UUIDs are normalized to lower case with '-' separators. We need to note that in the docs so that app creators who use the UUID as a string index don't get random failures or unexpected results.

@jrconlin jrconlin self-assigned this Mar 8, 2016
@ghost
Copy link

ghost commented Mar 8, 2016

Let's also have process_register return an error for channel IDs that aren't in that form. I think this would be less surprising than our current behavior, where we accept the ID, but then deliver to the normalized form.

At first glance, I think all we need to do is replace the check here: https://github.com/mozilla-services/autopush/blob/master/autopush/websocket.py#L996-L997 with one that checks data["channelID"] == normalize_id(data["channelID"]).

@jrconlin jrconlin added the ready label Mar 14, 2016
@bbangert bbangert added this to the PUSHSVC-0: quality milestone Mar 16, 2016
jrconlin added a commit that referenced this issue Apr 20, 2016
The code normalizes UUIDs used for channelIDs and UIADs to lower case,
dashed format. The docs now state that and the code will reject UUIDs
that are not well formatted. This is important for clients that may
normalize differently.

Fixes #392
jrconlin added a commit that referenced this issue Apr 20, 2016
The code normalizes UUIDs used for channelIDs and UIADs to lower case,
dashed format. The docs now state that and the code will reject UUIDs
that are not well formatted. This is important for clients that may
normalize differently.

BREAKING CHANGE: This patch will reject UUIDs that are not expressed as
lower case, dash formatted (e.g. "00001111-aaaa-bbbb-cccc-222233334444")

Closes #392
jrconlin added a commit that referenced this issue Apr 20, 2016
The code normalizes UUIDs used for channelIDs and UIADs to lower case,
dashed format. The docs now state that and the code will reject UUIDs
that are not well formatted. This is important for clients that may
normalize differently.

BREAKING CHANGE: This patch will reject UUIDs that are not expressed as
lower case, dash formatted (e.g. "00001111-aaaa-bbbb-cccc-222233334444")

Closes #392
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants