Craft 3.1.19 breaks entriesConnection, et al.

[timkelty]

Seems odd for a patch release, but queries with entriesConnection / tagsConnection / categoriesConnection started breaking upon upgrading craftcms/cms from 3.1.18 => 3.1.19.

I locked the version down and confirmed it works if I go back to 3.1.18.

Given query:

query {
  categoriesConnection(limit:1) {
    edges {
      node {
        id
      }
    }
  }
}

on craftcms/[email protected]:

{
  "errors": [
    {
      "message": "Internal server error",
      "category": "internal",
      "locations": [
        {
          "line": 2,
          "column": 3
        }
      ],
      "path": [
        "entriesConnection"
      ]
    }
  ],
  "data": {
    "entiresConnection": null
  }
}

on craftcms/[email protected]:

{
  "data": {
    "entriesConnection": {
      "edges": [
        {
          "node": {
            "id": 18881
          }
        }
      ]
    }
  }
}

I haven't peeked at the source of the 3.1.19 release yet, but maybe @brandonkelly might be able to shine some light.

[timkelty]

I've tried this with markhuot/[email protected] and dev-master with the same result.

[brandonkelly]

3.1.19 was a pretty tame release. Just looked through it and not really sure what could be messing with CraftQL. Happy to look into it further if anyone has any ideas.

[timkelty]

Looking through the release notes, my only guess is something to do with the pagination changes, as that is exposed through these element connections. (‘pageInfo’)

Hopefully will have some time to look into it this week.

[timkelty]

@brandonkelly hmmm does appear pagination related…the actual thrown exception:

2019-03-20 07:32:28 [-][-][-][error][yii\base\UnknownPropertyException] yii\base\UnknownPropertyException: Setting unknown property: craft\web\twig\variables\Paginate::limit in /app/vendor/composer/yiisoft/yii2/base/BaseObject.php:163

[brandonkelly]

@timkelty What is the stack trace?

[timkelty]

nothing helpful - still digging: 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/yiisoft/yii2/views/errorHandler/exception.php 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/yiisoft/yii2/views/errorHandler/callStackItem.php 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/yiisoft/yii2/views/errorHandler/callStackItem.php 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/yiisoft/yii2/views/errorHandler/callStackItem.php 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/yiisoft/yii2/views/errorHandler/callStackItem.php 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/yiisoft/yii2/views/errorHandler/callStackItem.php 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/yiisoft/yii2/views/errorHandler/callStackItem.php 2019-03-20 07:32:28 [-][-][-][trace][yii\base\View::renderFile] Rendering view file: /app/vendor/composer/y

[timkelty]

@brandonkelly Looking at the CrafQL code, I suspect its coming from \craft\helpers\Template::paginateCriteria($criteria):

craftql/src/Types/Query.php

Lines 113 to 129 in e4b5a43

	$this->addField('entriesConnection')
	->name('entriesConnection')
	->type(EntryConnection::class)
	->use(new EntryQueryArguments)
	->resolve(function ($root, $args, $context, $info) {
	$criteria = $this->getRequest()->entries(\craft\elements\Entry::find(), $root, $args, $context, $info);
	list($pageInfo, $entries) = \craft\helpers\Template::paginateCriteria($criteria);
	$pageInfo->limit = @$args['limit'] ?: 100;
	return [
	'totalCount' => $pageInfo->total,
	'pageInfo' => $pageInfo,
	'edges' => $entries,
	'criteria' => $criteria,
	'args' => $args,
	];
	});

[brandonkelly]

Huh… $pageInfo is a craft\web\twig\variables\Paginate object there, and that has never had a $limit property.

Here’s all of the changes made to that class in 2.0.19:

craftcms/cms@3.1.18...3.1.19#diff-d85eed56af7711fc3697dcae8e501448

So maybe this is just because we now have it extend yii\base\BaseObject, which is maybe more strict about setting unknown properties than vanilla classes are.

@markhuot Do you recall what the point of this line is?

craftql/src/Types/Query.php

Line 120 in e4b5a43

$pageInfo->limit = @$args['limit'] ?: 100;

[timkelty]

Yeah - seems like the intention is for the limit (default 100) to be on the $criteria, not $pageInfo.

[brandonkelly]

@markhuot Just submitted #249 to fix this, but I’m guessing all that is going to do is start limiting the results where previously they weren’t being limited at all, since limit wasn’t getting set on the element query like it would need to. So probably worth testing and making sure pagination works correctly.

[timkelty]

Thanks @brandonkelly!

[danireginatto]

+1 have a solution for this problem?

[swthate]

I'm interested in the progress of this as well. I'll have to hold some projects back to 3.1.18 until there is a fix as they rely on CraftQL 2 beta.

[markhuot]

Will be reviewing this, this week, to get a release cut.

[danireginatto]

Will be reviewing this, this week, to get a release cut.

Mark, Can you tell us when we can test? My system is broke.

[brandonkelly]

In the meantime you should be able to get it working (and help test) by switching over to my PR branch.

To do that, add my repo to the repositories config in composer.json, and change your markhuot/craftql requirement to dev-248-fix:

{
  "require": {
    "markhuot/craftql": "dev-248-fix",
    "...": "..."
  },
  "repositories": [
    {"type": "vcs", "url": "https://github.com/brandonkelly/craftql"}
  ],
  "...": "..."
}

Then run composer update.

[narration-sd]

That's a great contributive move,, @brandonkelly -- and a great method to keep in mind, seeing how it works....

[nc2-jordansmith]

Tested the dev-248-fix on Craft v3.1.19 and v3.1.20.1 and it works for me. I'll still need to wait for the release version for my team to use it, but thanks, @brandonkelly!

[dineufeld]

When to expect with an update? I have I an external API managed by CraftQL and I don't have an access to make downgrade of the craft version on the server.

[seamofreality]

Tested the dev-248-fix too (on Craft 3.1.20.1), got this error:

{
  "error": "Argument 1 passed to craft\\db\\Paginator::__construct() must implement interface yii\\db\\QueryInterface, array given, called in /usr/share/nginx/vendor/markhuot/craftql/src/Types/CategoryInterface.php on line 33"
}

Trying to query categories and their child entries:

{
  categories(group: teamCategory) {
    id
    title
    uri
    childrenConnection {
      edges {
        node {
          id
        }
      }
    }
  }
}

[brandonkelly]

@seamofreality Good catch. By the looks of it, a similar error would occur on the main release as well, pre-Craft 3.1.19. Just fixed it in my PR though. Try running composer clear-cache and then composer update.

[seamofreality]

@brandonkelly Thanks a dozen for the quick fix, it seems to work now!

[markhuot]

Release 1.3.2 should fix the issue based on the Paignator changes.