Gatsby: Use UUID version 5 for node IDs in source/transformer plugins

[KyleAMathews]

This was pointed out on Discord https://www.npmjs.com/package/uuid#version-5

Node IDs should be a) globally unique and b) meaningless so people don't rely on them for anything. Standardizing on UUID version 5 seems like a good way to accomplish this.

Thoughts?

[jquense]

I think we do some amount of regex'ing off the id as a path for documentation on www. but overall I think it's a good idea :)

[KyleAMathews]

Who wrote that code??? They should be fired! ;-)

Yeah, though we should probably make this change as part of v2.

[jquense]

it should already be fine to do deep filtering right e.g. internal.path, I find that most of the time I want the ability to search by file path, maybe we should add it automatically where it makes sense?

[arlair]

Hi, I am not sure if I am doing this wrong, but I found it quite useful to be able to specify my own id for a source plugin that used relational database tables. I could make the id based on the table name, row id and a name for my plugin (perhaps with an instance number if it was reusable). Then I don't need to create any hash maps to keep track of the ___NODE relations in the plugin and they can be generated based on the data.

It is also easier to debug the id with an error message something like:

Error: Invariant Violation: Encountered an error trying to infer a GraphQL type for: "data.{tableName}___NODE". There is no corresponding node with the id field matching: "{row id}-{plugin-name}{table name}"

[KyleAMathews]

@arlair could you create an issue for the error message? Sounds like a really helpful improvement!

[arlair]

@KyleAMathews The error already exists :) I was just showing how useful it became when I was able to specify a custom Gatsby id based on what should be unique information, rather than a new generated UUID id that would be harder to identify.

One option might be to build into the API a postfix for the Gatsby Id based on the plugin name and instance and maybe node type? When I first started trying to build a Gatsby plugin, I assumed I was meant to be passing in my own id and it would make it unique based on my plugin instance and the node type in internal.

I think I found it confusing because what turned out to be the Gatsby id was called id and lived in the root of the Node interface and not the internal area, but I've been meaning to write something up separately about that.

[danielfarrell]

I'm taking a go at this one, just FYI.

[KyleAMathews]

Thanks @danielfarrell!

[KyleAMathews]

Also sent you an invite to Gatsby's core team so you can assign yourself to issues in the future :-)

[calcsam]

Fixed in the PR, closing this

[KyleAMathews]

@calcsam @danielfarrell's PR was just to add the new helper function to v1 so this issue isn't done yet as we need to convert source/transformer plugins in v2 over to use UUIDs for ids.

[danielfarrell]

Is there a process that changes flow from master to v2? I can finish this up for v2, but didn't want to duplicate that code if it would flow through.

[KyleAMathews]

Yeah, I merge them in :-) Lemme do that real quick.

[KyleAMathews]

merged