mirror of
https://github.com/AnimeThemes/animethemes-server.git
synced 2026-07-11 01:24:46 +02:00
Kyrch
578 lines
21 KiB
PHP
578 lines
21 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
use App\Http\Middleware\GraphQL\LogGraphQLRequest;
|
|
use App\Http\Middleware\GraphQL\MaxCount;
|
|
|
|
return [
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Route Configuration
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Controls the HTTP route that your GraphQL server responds to.
|
|
| You may set `route` => false, to disable the default route
|
|
| registration and take full control.
|
|
|
|
|
*/
|
|
|
|
'route' => [
|
|
/*
|
|
* The URI the endpoint responds to, e.g. mydomain.com/graphql.
|
|
*/
|
|
'uri' => env('GRAPHQL_PATH', '/'),
|
|
|
|
/*
|
|
* Lighthouse creates a named route for convenient URL generation and redirects.
|
|
*/
|
|
'name' => 'graphql',
|
|
|
|
/*
|
|
* Beware that middleware defined here runs before the GraphQL execution phase.
|
|
* Make sure to return spec-compliant responses in case an error is thrown.
|
|
*/
|
|
'middleware' => [
|
|
'graphql',
|
|
|
|
// Allow client to get full database.
|
|
MaxCount::class,
|
|
|
|
// Logs GraphQL Requests.
|
|
LogGraphQLRequest::class,
|
|
|
|
// Ensures the request is not vulnerable to cross-site request forgery.
|
|
Nuwave\Lighthouse\Http\Middleware\EnsureXHR::class,
|
|
|
|
// Always set the `Accept: application/json` header.
|
|
Nuwave\Lighthouse\Http\Middleware\AcceptJson::class,
|
|
|
|
// Logs in a user if they are authenticated. In contrast to Laravel's 'auth'
|
|
// middleware, this delegates auth and permission checks to the field level.
|
|
Nuwave\Lighthouse\Http\Middleware\AttemptAuthentication::class,
|
|
|
|
// Logs every incoming GraphQL query.
|
|
// Nuwave\Lighthouse\Http\Middleware\LogGraphQLQueries::class,
|
|
],
|
|
|
|
/*
|
|
* The `prefix`, `domain` and `where` configuration options are optional.
|
|
*/
|
|
// 'prefix' => '',
|
|
'domain' => env('GRAPHQL_URL'),
|
|
// 'where' => [],
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Authentication Guards
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| The guards to use for authenticating GraphQL requests, if needed.
|
|
| Used in directives such as `@guard` or the `AttemptAuthentication` middleware.
|
|
| Falls back to the Laravel default if `null`.
|
|
|
|
|
*/
|
|
|
|
'guards' => null,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Schema Path
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Path to your .graphql schema file.
|
|
| Additional schema files may be imported from within that file.
|
|
|
|
|
*/
|
|
|
|
'schema_path' => base_path('graphql/schema.graphql'),
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Schema Cache
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| A large part of schema generation consists of parsing and AST manipulation.
|
|
| This operation is very expensive, so it is highly recommended enabling
|
|
| caching of the final schema to optimize performance of large schemas.
|
|
|
|
|
*/
|
|
|
|
'schema_cache' => [
|
|
/*
|
|
* Setting to true enables schema caching.
|
|
*/
|
|
'enable' => env('LIGHTHOUSE_SCHEMA_CACHE_ENABLE', env('APP_ENV') !== 'local'),
|
|
|
|
/*
|
|
* File path to store the lighthouse schema.
|
|
*/
|
|
'path' => env('LIGHTHOUSE_SCHEMA_CACHE_PATH', base_path('bootstrap/cache/lighthouse-schema.php')),
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Cache Directive Tags
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Should the `@cache` directive use a tagged cache?
|
|
|
|
|
*/
|
|
'cache_directive_tags' => false,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Query Cache
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Caches the result of parsing incoming query strings to boost performance on subsequent requests.
|
|
|
|
|
*/
|
|
|
|
'query_cache' => [
|
|
/*
|
|
* Setting to true enables query caching.
|
|
*/
|
|
'enable' => env('LIGHTHOUSE_QUERY_CACHE_ENABLE', true),
|
|
|
|
/*
|
|
* Configures which mechanism to use for the query cache.
|
|
* - store: use an external shared cache through a Laravel cache store like Redis or Memcached
|
|
* - opcache: store parsed queries in PHP files on the local filesystem to leverage OPcache
|
|
* - hybrid: leverage OPcache, but use a shared cache store when local files are not found
|
|
*/
|
|
'mode' => env('LIGHTHOUSE_QUERY_CACHE_MODE', 'store'),
|
|
|
|
/*
|
|
* Specifies the path where the PHP files are stored when using opcache or hybrid mode.
|
|
* The given path must be a folder, as every query will produce its own file.
|
|
*/
|
|
'opcache_path' => env('LIGHTHOUSE_QUERY_CACHE_OPCACHE_PATH', base_path('bootstrap/cache')),
|
|
|
|
/*
|
|
* Allows using a specific cache store, uses the app's default if set to null.
|
|
* Not relevant when using opcache mode.
|
|
*/
|
|
'store' => env('LIGHTHOUSE_QUERY_CACHE_STORE', null),
|
|
|
|
/*
|
|
* Duration in seconds the query should remain cached, null means forever.
|
|
* Not relevant when using opcache mode.
|
|
*/
|
|
'ttl' => env('LIGHTHOUSE_QUERY_CACHE_TTL', 24 * 60 * 60),
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Validation Cache
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Caches the result of validating queries to boost performance on subsequent requests.
|
|
|
|
|
*/
|
|
|
|
'validation_cache' => [
|
|
/*
|
|
* Setting to true enables validation caching.
|
|
*/
|
|
'enable' => env('LIGHTHOUSE_VALIDATION_CACHE_ENABLE', false),
|
|
|
|
/*
|
|
* Allows using a specific cache store, uses the app's default if set to null.
|
|
*/
|
|
'store' => env('LIGHTHOUSE_VALIDATION_CACHE_STORE', null),
|
|
|
|
/*
|
|
* Duration in seconds the validation result should remain cached, null means forever.
|
|
*/
|
|
'ttl' => env('LIGHTHOUSE_VALIDATION_CACHE_TTL', 24 * 60 * 60),
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Parse source location
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Should the source location be included in the AST nodes resulting from query parsing?
|
|
| Setting this to `false` improves performance, but omits the key `locations` from errors,
|
|
| see https://spec.graphql.org/October2021/#sec-Errors.Error-result-format.
|
|
|
|
|
*/
|
|
|
|
'parse_source_location' => true,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Namespaces
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| These are the default namespaces where Lighthouse looks for classes to
|
|
| extend functionality of the schema. You may pass in either a string
|
|
| or an array, they are tried in order and the first match is used.
|
|
|
|
|
*/
|
|
|
|
'namespaces' => [
|
|
'models' => ['App\\Models', 'App\\Pivots'],
|
|
'queries' => 'App\\GraphQL\\Queries',
|
|
'mutations' => 'App\\GraphQL\\Mutations',
|
|
'subscriptions' => 'App\\GraphQL\\Subscriptions',
|
|
'types' => 'App\\GraphQL\\Types',
|
|
'interfaces' => 'App\\GraphQL\\Interfaces',
|
|
'unions' => 'App\\GraphQL\\Unions',
|
|
'scalars' => 'App\\GraphQL\\Scalars',
|
|
'directives' => 'App\\GraphQL\\Directives',
|
|
'validators' => 'App\\GraphQL\\Validators',
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Security
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Control how Lighthouse handles security related query validation.
|
|
| Read more at https://webonyx.github.io/graphql-php/security/
|
|
|
|
|
*/
|
|
|
|
'security' => [
|
|
// Handled dynamically
|
|
'max_query_complexity' => GraphQL\Validator\Rules\QueryComplexity::DISABLED,
|
|
'max_query_depth' => 13,
|
|
'disable_introspection' => (bool) env('LIGHTHOUSE_SECURITY_DISABLE_INTROSPECTION', false)
|
|
? GraphQL\Validator\Rules\DisableIntrospection::ENABLED
|
|
: GraphQL\Validator\Rules\DisableIntrospection::DISABLED,
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Pagination
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Set defaults for the pagination features within Lighthouse, such as
|
|
| the @paginate directive, or paginated relation directives.
|
|
|
|
|
*/
|
|
|
|
'pagination' => [
|
|
/*
|
|
* Allow clients to query paginated lists without specifying the amount of items.
|
|
* Setting this to `null` means clients have to explicitly ask for the count.
|
|
*/
|
|
'default_count' => 15,
|
|
|
|
/*
|
|
* Limit the maximum amount of items that clients can request from paginated lists.
|
|
* Setting this to `null` means the count is unrestricted.
|
|
*/
|
|
'max_count' => 100,
|
|
|
|
// Custom keys
|
|
'relation' => [
|
|
/*
|
|
* Allow clients to query paginated lists without specifying the amount of items.
|
|
* Setting this to `null` means clients have to explicitly ask for the count.
|
|
*/
|
|
'default_count' => 1000,
|
|
|
|
/*
|
|
* Limit the maximum amount of items that clients can request from paginated lists.
|
|
* Setting this to `null` means the count is unrestricted.
|
|
*/
|
|
'max_count' => null,
|
|
],
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Debug
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Control the debug level as described in https://webonyx.github.io/graphql-php/error-handling/
|
|
| Debugging is only applied if the global Laravel debug config is set to true.
|
|
|
|
|
| When you set this value through an environment variable, use the following reference table:
|
|
| 0 => INCLUDE_NONE
|
|
| 1 => INCLUDE_DEBUG_MESSAGE
|
|
| 2 => INCLUDE_TRACE
|
|
| 3 => INCLUDE_TRACE | INCLUDE_DEBUG_MESSAGE
|
|
| 4 => RETHROW_INTERNAL_EXCEPTIONS
|
|
| 5 => RETHROW_INTERNAL_EXCEPTIONS | INCLUDE_DEBUG_MESSAGE
|
|
| 6 => RETHROW_INTERNAL_EXCEPTIONS | INCLUDE_TRACE
|
|
| 7 => RETHROW_INTERNAL_EXCEPTIONS | INCLUDE_TRACE | INCLUDE_DEBUG_MESSAGE
|
|
| 8 => RETHROW_UNSAFE_EXCEPTIONS
|
|
| 9 => RETHROW_UNSAFE_EXCEPTIONS | INCLUDE_DEBUG_MESSAGE
|
|
| 10 => RETHROW_UNSAFE_EXCEPTIONS | INCLUDE_TRACE
|
|
| 11 => RETHROW_UNSAFE_EXCEPTIONS | INCLUDE_TRACE | INCLUDE_DEBUG_MESSAGE
|
|
| 12 => RETHROW_UNSAFE_EXCEPTIONS | RETHROW_INTERNAL_EXCEPTIONS
|
|
| 13 => RETHROW_UNSAFE_EXCEPTIONS | RETHROW_INTERNAL_EXCEPTIONS | INCLUDE_DEBUG_MESSAGE
|
|
| 14 => RETHROW_UNSAFE_EXCEPTIONS | RETHROW_INTERNAL_EXCEPTIONS | INCLUDE_TRACE
|
|
| 15 => RETHROW_UNSAFE_EXCEPTIONS | RETHROW_INTERNAL_EXCEPTIONS | INCLUDE_TRACE | INCLUDE_DEBUG_MESSAGE
|
|
|
|
|
*/
|
|
|
|
'debug' => env('LIGHTHOUSE_DEBUG', GraphQL\Error\DebugFlag::INCLUDE_DEBUG_MESSAGE | GraphQL\Error\DebugFlag::INCLUDE_TRACE),
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Error Handlers
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Register error handlers that receive the Errors that occur during execution
|
|
| and handle them. You may use this to log, filter or format the errors.
|
|
| The classes must implement \Nuwave\Lighthouse\Execution\ErrorHandler
|
|
|
|
|
*/
|
|
|
|
'error_handlers' => [
|
|
Nuwave\Lighthouse\Execution\AuthenticationErrorHandler::class,
|
|
Nuwave\Lighthouse\Execution\AuthorizationErrorHandler::class,
|
|
Nuwave\Lighthouse\Execution\ValidationErrorHandler::class,
|
|
Nuwave\Lighthouse\Execution\ReportingErrorHandler::class,
|
|
App\GraphQL\ErrorHandler\TypesenseErrorHandler::class,
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Field Middleware
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Register global field middleware directives that wrap around every field.
|
|
| Execution happens in the defined order, before other field middleware.
|
|
| The classes must implement \Nuwave\Lighthouse\Support\Contracts\FieldMiddleware
|
|
|
|
|
*/
|
|
|
|
'field_middleware' => [
|
|
Nuwave\Lighthouse\Schema\Directives\TrimDirective::class,
|
|
Nuwave\Lighthouse\Schema\Directives\ConvertEmptyStringsToNullDirective::class,
|
|
Nuwave\Lighthouse\Schema\Directives\SanitizeDirective::class,
|
|
Nuwave\Lighthouse\Validation\ValidateDirective::class,
|
|
Nuwave\Lighthouse\Schema\Directives\TransformArgsDirective::class,
|
|
Nuwave\Lighthouse\Schema\Directives\SpreadDirective::class,
|
|
Nuwave\Lighthouse\Schema\Directives\RenameArgsDirective::class,
|
|
Nuwave\Lighthouse\Schema\Directives\DropArgsDirective::class,
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Global ID
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| The name that is used for the global id field on the Node interface.
|
|
| When creating a Relay compliant server, this must be named "id".
|
|
|
|
|
*/
|
|
|
|
'global_id_field' => 'id',
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Persisted Queries
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Lighthouse supports Automatic Persisted Queries (APQ), compatible with the
|
|
| [Apollo implementation](https://www.apollographql.com/docs/apollo-server/performance/apq).
|
|
| You may set this flag to either process or deny these queries.
|
|
|
|
|
*/
|
|
|
|
'persisted_queries' => true,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Transactional Mutations
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| If set to true, the execution of built-in directives that mutate models
|
|
| will be wrapped in a transaction to ensure atomicity.
|
|
| The transaction is committed after the root field resolves,
|
|
| thus errors in nested fields do not cause a rollback.
|
|
|
|
|
*/
|
|
|
|
'transactional_mutations' => true,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Mass Assignment Protection
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| If set to true, mutations will use forceFill() over fill() when populating
|
|
| a model with arguments in mutation directives. Since GraphQL constrains
|
|
| allowed inputs by design, mass assignment protection is not needed.
|
|
|
|
|
*/
|
|
|
|
'force_fill' => true,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Batchload Relations
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| If set to true, relations marked with directives like @hasMany or @belongsTo
|
|
| will be optimized by combining the queries through the BatchLoader.
|
|
|
|
|
*/
|
|
|
|
'batchload_relations' => true,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Shortcut Foreign Key Selection
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| If set to true, Lighthouse will shortcut queries where the client selects only the
|
|
| foreign key pointing to a related model. Only works if the related model's primary
|
|
| key field is called exactly `id` for every type in your schema.
|
|
|
|
|
*/
|
|
|
|
'shortcut_foreign_key_selection' => false,
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| GraphQL Subscriptions
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Here you can define GraphQL subscription broadcaster and storage drivers
|
|
| as well their required configuration options.
|
|
|
|
|
*/
|
|
|
|
'subscriptions' => [
|
|
/*
|
|
* Determines if broadcasts should be queued by default.
|
|
*/
|
|
'queue_broadcasts' => env('LIGHTHOUSE_QUEUE_BROADCASTS', true),
|
|
|
|
/*
|
|
* Determines the queue to use for broadcasting queue jobs.
|
|
*/
|
|
'broadcasts_queue_name' => env('LIGHTHOUSE_BROADCASTS_QUEUE_NAME', null),
|
|
|
|
/*
|
|
* Default subscription storage.
|
|
*
|
|
* Any Laravel supported cache driver options are available here.
|
|
*/
|
|
'storage' => env('LIGHTHOUSE_SUBSCRIPTION_STORAGE', 'redis'),
|
|
|
|
/*
|
|
* Default subscription storage time to live in seconds.
|
|
*
|
|
* Indicates how long a subscription can stay active before automatic removal from storage.
|
|
* Setting this to `null` means the subscriptions are stored forever. This may cause
|
|
* stale subscriptions to linger indefinitely in case cleanup fails for any reason.
|
|
*/
|
|
'storage_ttl' => env('LIGHTHOUSE_SUBSCRIPTION_STORAGE_TTL', null),
|
|
|
|
/*
|
|
* Encrypt subscription channels by prefixing their names with "private-encrypted-"?
|
|
*/
|
|
'encrypted_channels' => env('LIGHTHOUSE_SUBSCRIPTION_ENCRYPTED', false),
|
|
|
|
/*
|
|
* Default subscription broadcaster.
|
|
*/
|
|
'broadcaster' => env('LIGHTHOUSE_BROADCASTER', 'pusher'),
|
|
|
|
/*
|
|
* Subscription broadcasting drivers with config options.
|
|
*/
|
|
'broadcasters' => [
|
|
'log' => [
|
|
'driver' => 'log',
|
|
],
|
|
'echo' => [
|
|
'driver' => 'echo',
|
|
'connection' => env('LIGHTHOUSE_SUBSCRIPTION_REDIS_CONNECTION', 'default'),
|
|
'routes' => Nuwave\Lighthouse\Subscriptions\SubscriptionRouter::class.'@echoRoutes',
|
|
],
|
|
'pusher' => [
|
|
'driver' => 'pusher',
|
|
'connection' => 'pusher',
|
|
'routes' => Nuwave\Lighthouse\Subscriptions\SubscriptionRouter::class.'@pusher',
|
|
],
|
|
'reverb' => [
|
|
'driver' => 'pusher',
|
|
'connection' => 'reverb',
|
|
'routes' => Nuwave\Lighthouse\Subscriptions\SubscriptionRouter::class.'@reverb',
|
|
],
|
|
],
|
|
|
|
/*
|
|
* Should the subscriptions extension be excluded when the response has no subscription channel?
|
|
* This optimizes performance by sending less data.
|
|
* Clients must anticipate this behavior.
|
|
*/
|
|
'exclude_empty' => env('LIGHTHOUSE_SUBSCRIPTION_EXCLUDE_EMPTY', true),
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Defer
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Configuration for the experimental @defer directive support.
|
|
|
|
|
*/
|
|
|
|
'defer' => [
|
|
/*
|
|
* Maximum number of nested fields that can be deferred in one query.
|
|
* Once reached, remaining fields will be resolved synchronously.
|
|
* 0 means unlimited.
|
|
*/
|
|
'max_nested_fields' => 0,
|
|
|
|
/*
|
|
* Maximum execution time for deferred queries in milliseconds.
|
|
* Once reached, remaining fields will be resolved synchronously.
|
|
* 0 means unlimited.
|
|
*/
|
|
'max_execution_ms' => 0,
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Apollo Federation
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Lighthouse can act as a federated service: https://www.apollographql.com/docs/federation/federation-spec.
|
|
|
|
|
*/
|
|
|
|
'federation' => [
|
|
/*
|
|
* Location of resolver classes when resolving the `_entities` field.
|
|
*/
|
|
'entities_resolver_namespace' => 'App\\GraphQL\\Entities',
|
|
],
|
|
|
|
/*
|
|
|--------------------------------------------------------------------------
|
|
| Tracing
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
| Configuration for tracing support.
|
|
|
|
|
*/
|
|
|
|
'tracing' => [
|
|
/*
|
|
* Driver used for tracing.
|
|
*
|
|
* Accepts the fully qualified class name of a class that implements Nuwave\Lighthouse\Tracing\Tracing.
|
|
* Lighthouse provides:
|
|
* - Nuwave\Lighthouse\Tracing\ApolloTracing\ApolloTracing::class
|
|
* - Nuwave\Lighthouse\Tracing\FederatedTracing\FederatedTracing::class
|
|
*
|
|
* In Lighthouse v7 the default will be changed to 'Nuwave\Lighthouse\Tracing\FederatedTracing\FederatedTracing::class'.
|
|
*/
|
|
'driver' => Nuwave\Lighthouse\Tracing\ApolloTracing\ApolloTracing::class,
|
|
],
|
|
];
|