Allow for IDs to contain : characters
#19
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I was recently building a toy project with Relay and GraphQL where I
needed to encode extra information in my global ID. To do this, I
decided to add an `idFetcher` argument to my `globalIdField` call that
returned a string that was delimited by a `:`. However, this did not
work because of how globalIds are deconstructed in `fromGlobalId`, so
instead of getting my encoded ID (e.g. `123:test`) I just got the ID
part (e.g. `123`).
To prevent this confusion, it might be nice to either warn when this
happens or use a different strategy in `fromGlobalId` than `split`. In
this commit, I swap out the `split` for a performant
`indexOf`/`substring` approach that satisfies this use-case. Of course,
a regex version would also work here:
export function fromGlobalId(globalId: string): ResolvedGlobalId {
var tokens = unbase64(globalId).match(/(.+?):(.+)/);
return {
type: tokens[1],
id: tokens[2]
};
}
Fixes graphql#18
Contributor
|
Awesome, thanks! |
dschafer
added a commit
that referenced
this pull request
Aug 28, 2015
Allow for IDs to contain `:` characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was recently building a toy project with Relay and GraphQL where I
needed to encode extra information in my global ID. To do this, I
decided to add an
idFetcherargument to myglobalIdFieldcall thatreturned a string that was delimited by a
:. However, this did notwork because of how globalIds are deconstructed in
fromGlobalId, soinstead of getting my encoded ID (e.g.
123:test) I just got the IDpart (e.g.
123).To prevent this confusion, it might be nice to either warn when this
happens or use a different strategy in
fromGlobalIdthansplit. Inthis commit, I swap out the
splitfor a performantindexOf/substringapproach that satisfies this use-case. Of course,a regex version would also work here:
Fixes #18