Keystone: Underscore in field name causes GraphQL error: Unable to find Mongo field which maps to graphQL path error

[derkweijers]

Bug report

Describe the bug

I'm migrating from Keystone 4 to Keystone 5. I have a database that has fields which have underscores in them (news_site, news_site_long). When I define these fields in createList I get the following error:

GraphQL error: Unable to find Mongo field which maps to graphQL path news

I've been searching in the docs to prevent this behavior, but I couldn't find an option.

To Reproduce

Steps to reproduce the behaviour. Please provide code snippets or a repository:

1. Define a field with an underscore in it
2. In the admin GUI, Click on the list
3. See error

Expected behaviour

I expect to see a list of all my entries in that MongoDB collection.

Screenshots

System information

• OS: Debian, MacOS
• Browser (if applies): Opera, Chrome

Additional context

[Vultraz]

Did you try camelcase? Ie, newsSite and newsSiteLong?

[derkweijers]

Hi,

Thanks! I've been away this weekend and will check it tonight.

Kind regards,
Derk

[derkweijers]

No errors with camelcase, but also no data:

[Vultraz]

Hmmmmmmm... well, definitely sounds like a bug if you can't access fields with underscores 😬 Is there any way for you to convert the values on the DB side to camelcase? With the Mongo shell, perhaps?

[derkweijers]

To test or permanently? If it's to test something; yes. If it's for real; I'm afraid that will get me in trouble with devs that connect to my API :)

[Vultraz]

Ooof 😂 Yeah, I was suggesting for production. Let's see if @MadeByMike has any insight...

[MadeByMike]

I can't seem to reproduce this one. Here is the test config I used:

keystone.createList("Test", {
  fields: {
    name: { type: Text },
    the_mostest_underscores: { type: Text }
  }
});

I opened the Admin UI and I was able to create an item. The field labels and data both showed up:

Have I done this right?

[derkweijers]

Hi!

Apologies for the late reply, I'm a bit busy.

It looks the same yes, here's my code:
module.exports = { fields: { newsSite: { type: Text, isRequired: true, }, ... }

In my index.js file (enty point):
keystone.createList('Article', ArticleSchema);

Here's a snippet directly from MongoDB:

And this results in what's posted before.

I hadn't tried creating new documents and I just did. This seems to work at first (I see them in the UI) but it's inserted camel cased in the database:

Fun thing to notice: the featured_image field does work as expected. I'm totally lost right now.

[derkweijers]

By accident, I found a possible solution/workaround:
Define a non-underscore item as first item in the list (title, name, etc.). All underscore items will now behave correctly.

[derkweijers]

Unfortunately, with defaultSort: it breaks again when you try to sort on an item with an underscore.

[kvssandhu]

Facing similar issue.

Solution : change the item names to camelCase (for Mongo Users)

In case you are using Knex Adapter with postgreSQL, change the item names to all lowercase or uppercase, depending upon column names in your DB.

[derkweijers]

Facing similar issue.

Solution : change the item names to camelCase (for Mongo Users)

In case you are using Knex Adapter with postgreSQL, change the item names to all lowercase or uppercase, depending upon column names in your DB.

That worked partially for me, as defaultSort: breaks it again.

[stale[bot]]

It looks like there hasn't been any activity here in over 6 months. Sorry about that! We've flagged this issue for special attention. It wil be manually reviewed by maintainers, not automatically closed. If you have any additional information please leave us a comment. It really helps! Thank you for you contribution. :)

[hew]

This also occurs over on the Postgres side. When you click to sort by key, any key with an underscore will throw the following error:

GraphQL error: Cannot read property 'sortKey' of undefined

Since keystone caches the currently visible tabs, all subsequent reloads without clearing the cache will throw the error before even displaying any information.

Kind of a major bug. If anyone has any workarounds that would be great.

[hew]

Actually never mind, you don't have to click anything. The underscore fields with fail on render.

[hew]

Steps to reproduce:

1. Start a new keystone project
2. Choose postgres/Knex
3. Create a list with a key that has an underscore
4. Try to view that list

 "@keystonejs/adapter-knex": "^10.0.0",
 "@keystonejs/app-admin-ui": "^6.0.0",

[stale[bot]]

It looks like there hasn't been any activity here in over 6 months. Sorry about that! We've flagged this issue for special attention. It wil be manually reviewed by maintainers, not automatically closed. If you have any additional information please leave us a comment. It really helps! Thank you for you contribution. :)

[cicibobo]

By accident, I found a possible solution/workaround:
Define a non-underscore item as first item in the list (title, name, etc.). All underscore items will now behave correctly.

Works for me as well

[radospanny]

I have still issue with a field name containing underscore. The GraphQL returns error in sortBy. Any help?
Thank you very much.