如何在Laravel Lighthouse中檢查查詢的深度和複雜度

Question

在將lighthouse部署到生產伺服器之前，我會檢查安全性（https://www.howtographql.com/advanced/4-security/）。因此，我決定檢查查詢深度和查詢複雜度。

在lighthouse文件中，他們提到了config/lighthouse.php。

/*
|------------------------------------------------- -------------------------
| Security
|------------------------------------------------- -------------------------
|
| 控制Lighthouse處理與安全相關的查詢驗證。
| 詳細閱讀：https://webonyx.github.io/graphql-php/security/
|
*/
'security' => [
    'max_query_complexity' => \GraphQL\Validator\Rules\QueryComplexity::DISABLED,
    'max_query_depth' => \GraphQL\Validator\Rules\QueryDepth::DISABLED,
    'disable_introspection' => \GraphQL\Validator\Rules\DisableIntrospection::DISABLED,
],

並推薦閱讀https://webonyx.github.io/graphql-php/security/。

在這個連結中，他們給了一些例子：

use GraphQL\GraphQL;
use GraphQL\Validator\Rules\QueryComplexity;
use GraphQL\Validator\DocumentValidator;

$rule = new QueryComplexity($maxQueryComplexity = 100);
DocumentValidator::addRule($rule);

GraphQL::executeQuery(/*...*/);

use GraphQL\GraphQL;
use GraphQL\Validator\Rules\QueryDepth;
use GraphQL\Validator\DocumentValidator;

$rule = new QueryDepth($maxDepth = 10);
DocumentValidator::addRule($rule);

GraphQL::executeQuery(/*...*/);

但是如何在lighthouse應用這些呢？

首先，我將這些程式碼寫入了ExampleQuery.php（php artisan lighthouse:query ExampleQuery）。

final class ExampleQuery
{
    public function __invoke(_, array $args)
    {
        $rule = new QueryComplexity(2);
        DocumentValidator::addRule($rule);

        $rule2 = new QueryDepth(2);
        DocumentValidator::addRule($rule2);

        return [
            …
        ];
    }
}

但是這樣無法捕捉任何問題。

我認為lighthouse在vendor/nuwave/.../GraphQLController.php中啟動，所以我無法執行GraphQL::executeQuery(/*...*/ );

@complexity指令也不起作用，@complexity(resolver: "App\\Security\\ComplexityAnalyzer@userPosts")不會呼叫userPosts函數。

class ComplexityAnalyzer {

    public function userPosts(int $childrenComplexity, array $args): int // not called
    {
        $postComplexity = $args['includeFullText']
            ? 3
            : 2;
        \Log::Debug($postComplexity); // not called
        return $childrenComplexity * $postComplexity;

    }
}

我錯過了什麼？請幫助我睡個舒服覺。

Answer 1

它已經實現了，你只需要設定值。

'security' => [
        'max_query_complexity' => 100,
        'max_query_depth' => 10,
    ],

複雜度分數計算可以使用@complexity指令對每個欄位進行修改。