⚡️ A PHP GraphQL Framework

Reflection

• [x] Merge railt/parser and railt/reflection into single package.
• [x] Remove railt/support package.
• [x] Release alpha 1 (composer require railt/compiler 0.0.1)
• [x] Fix and improve arguments LSP (Reflection).
• [x] To get rid of checks of a status of the builder and to take out in validation from the outside (visitor?).
• [x] Remove "extend" from visible types and make preprocessing kernel (required for future additional features like #21 ).
• [x] Exceptions improvement: https://github.com/railt/railt/issues/23
• [x] Add type verifications.
• [x] Types inheritance bugfixes.
• [x] ~Waiting for https://github.com/hoaproject/Compiler/pull/76~
• [x] ~Waiting for https://github.com/hoaproject/Compiler/pull/79~
• [x] ~Waiting for a new release of hoa/compiler~ (forked into: https://github.com/railt/parser)
• [x] Release 1.0

Webonyx builder

• [x] Implement the base Webonyx support
• [x] Add support of Field Type
• [x] Add support of Argument Type
• [x] Add support of SchemaType
• [x] Add support of Object Type
• [x] Add support of Interface Type
• [x] ~Add support of Union Type~
• [x] Add support of Directive Type
• [x] Add support of Scalar Type
• [x] ~Add support of Enum Type~
• [x] ~Add support of Input Type~
• [x] Add type invocations base hooks support

Jan'18 →

Is possible to add a feature that i can write multiple graphql files and combine than in a one?

Example:

UserSchema.graphqls

type Query{
   users: User[]
}
type User{
  name: String
  login: String
  email: String
  role: Role
}

RoleSchema.graphqls

type Query{
   roles: Role[]
}
type Role{
  name: String
  level: Int
}

And the root schema: schema.graphqls

schema{
   query: Query
}

The result schema should be:

schema{
   query: Query
}
type Query{
   roles: Role[]
   users: User[]
}
type User{
  name: String
  login: String
  email: String
  role: Role
}
type Role{
  name: String
  level: Int
}

Or, maybe using directives:

schema{
   query: Query
}
@import(schema: "UserSchema.graphqls")
@import(schema: "RoleSchema.graphqls")

In this webonyx issue https://github.com/webonyx/graphql-php/issues/180#issuecomment-444478026 there are something like that, maybe is a way to start.

This will be nice for a huge number of types and queries.

Thanks.

Hello, i'm very excited about this project.

I'm trying to integrate this on phalcon framework, and what i'm trying to do is to create a directive to handle user authorizations. My idea is similar to the solution made to laravel integration, found in this repository https://github.com/SerafimArts/railt-authorization, but this don't solve my problem, because i'm not using laravel.

I know that the docs are not made yet, but, can you give a example of how to do this? I'm using the 1.3.5 version of railt. Is there a way to just add a directive using directly the Application class? And how the extensions works??

I'm trying to avoid to do that in controller classes because this will be a very repetitive task and it's not a elegant solution.

I want to use the route directive to solve custom type fields, using the root type, for example:

type Query{
 usuario: [Usuario]
   @route(action: "UserController@list")
}


type Role {
    _key: ID!
    nome: String
}

type User {
    _key: ID!
    nome: String
    login: String
    email: String
    role: Role  
        @route(action: "RoleController@roleByUserId")
}

and

class RoleController{
 public function roleByUserId($parent){ //argument $parent can access all the parent data
  $userId = $parent['_key']

  //return the role of the user
 }
}

In other words, i want a way to pass a parameter to the controller, and his value will be the same as the field of the type in which the @route directive is declared.

This will be very useful, because we don't need to solve the type "Role" each time that the type "User" are used, for example.

In webonyx we have something like this:

<?php
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => [
        'echo' => [
            'type' => Type::string(),
            'args' => [
                'message' => Type::nonNull(Type::string()),
            ],
            'resolve' => function ($root, $args) {
                return $root['prefix'] . $args['message'];
            }
        ],
    ],
]);

The key of the question is that part:

'resolve' => function ($root, $args) {
                return $root['prefix'] . $args['message'];
            }

the $root variable, this is what a want.

It's there a way to do that, maybe using extensions??

railt/compiler 1.3 seems to have a regression that does not allow me to read some pp2 files.

Expected Behavior

The following is my pp2 file. It parses correctly under railt/compiler 1.2.1:

// MijnArchief Query Language definition

%skip space \s+

// Scalars
%token true     TRUE|true
%token false    FALSE|false
%token null     NULL|null
%token date     (\d{4}-\d{2}-\d{2})(?:T(\d{2}:\d{2}))?
%token number   \d+
%token dstring  "([^"]*)"
%token sstring  '([^']*)'

// Comparisons
%token eq   =
%token neq  !=
%token gt   >
%token lt   <
%token gte  >=
%token lte  <=

// Logic
%token and     AND|and
%token or      OR|or
%token not     NOT|not

// Grouping
%token brace_  \(
%token _brace  \)

// Fields
%token field    \w+

#conditionalOr -> Prezent\Infrastructure\Query\AST\ConditionalOr:
    conditionalAnd() ( ::or:: conditionalAnd() )*

#conditionalAnd -> Prezent\Infrastructure\Query\AST\ConditionalAnd:
    simpleExpression() ( ::and:: simpleExpression() )*

simpleExpression:
    filter() | negation() | group()

#negation -> Prezent\Infrastructure\Query\AST\Negation:
    ::not:: simpleExpression()

group:
    ::brace_:: conditionalOr() ::_brace::

#filter -> Prezent\Infrastructure\Query\AST\Filter:
    <field> comparisonOperator() scalar()

#comparisonOperator -> Prezent\Infrastructure\Query\AST\ComparisonOperator:
    <eq> | <neq> | <gt> | <lt> | <gte> | <lte>

#scalar -> Prezent\Infrastructure\Query\AST\Scalar:
    <true> | <false> | <null> | <date> | <number> | <dstring> | <sstring>

What happens instead?

I get the following exception using railt/compiler 1.3.0:

Error while Railt\Compiler\Grammar\Delegate\TokenDelegate initialization: Argument 1 passed to Railt\Parser\Ast\Rule::__construct() must be of the type string, object given, called in /opt/www/sites/sander/mijnarchief/vendor/railt/parser/src/Parser/Ast/Builder.php on line 160

Description

The problem is that my pp2 file uses delegates. In line 160 it calls new $delegate($rule). But, the delegate class extends Railt\Parser\Ast\Rule (as suggested in your documentation) and it's constructor does not work here.

Note that the delegate constructor is not part of the RuleInterface or LeafInterface!

Steps To Reproduce

Parse the pp2 using railt/compiler 1.3

Environment

• Railt Version: 1.3
• PHP Version: 7.2

It is required to find out the reason for the slow work of the parser because In this embodiment, it cannot be used parse requests (GraphQL Queries).

Benchmarks

100 iterations per query Example { field } query.

Railt 1.4.x-dev

use Railt\Io\File;
use Railt\GraphQL\Frontend\Parser;

$parser = new Parser();

for ($i = 0; $i < $count; $i++) {
    $parser->parse(File::fromSources('query Example { field }'));
}

Result: 0.7785s (100%)

Webonyx 0.13.0

Link: https://github.com/webonyx/graphql-php

use GraphQL\Language\Source;
use GraphQL\Language\Parser;

for ($i = 0; $i < $count; $i++) {
    Parser::parse(new Source('query Example { field }'));
}

Result: 0.0363s (+2144%)

Divide the routing component into two component parts:

• Routing
• Decorators

Routing

The route must return complete data for the response, including all available relations.

Definitions

The following methods should be implemented:

• ->query('name', '...'): Must respond to query requests.
• ->mutation('name', '...'): Must respond to mutation requests.
• ->subscription('name', '...'): Must respond to subscription requests.
• ->on('name', '...'): Must respond to all requests.

The second argument is a router handler (callable or string definition ClassName@action).

The action should provide complete information about the:

• Relations
• Arguments
• Field type
• ...other

Example:

schema {
    query: Query
}

type Query {
    users: [User]!
}

type User {
    id: ID!
    name: String!
    friends: [User]!
    createdAt: DateTime!
}

$router->query('users', function (Input $input) {
    $query = new DatabaseBuilder();

    if ($input->hasRelation('friends')) {
        $query->leftJoin(...);
    }
    
    return $query->get();
});

Decorators

The decorators system should provide the ability to manage and format already generated data. A class must implement at least three methods:

Middleware

Definition ->middleware('name', '...'). The first argument contains the name and group of the middlevare, the second is the response handler. The nesting group is separated by a "dot" (.) symbol. To use this decoration system - it must be declared in routs explicitly.

Example:

// Definition
$decorators->middleware('example', function ($input, $output) { ... });

// Usage the "example" middleware
$router->on('users', function (...) { ... })->middleware('example');

Example with groups:

// Definition
$decorators->middleware('group-example.test1', function ($input, $output) { ... });
$decorators->middleware('group-example.test2', function ($input, $output) { ... });
$decorators->middleware('group-example', function ($input, $output) { ... });

// Usage of "group-example", "group-example.test1" and "group-example.test2" middleware
$router->on('users', function (...) { ... })->middleware('group-example'); 

Path

The definition of "path decorators" should point explicitly to the field in the query inheritance chain (the collection indexes should not be taken into account when compiling the path).

Example

// Processing the field "createdAt" for the GraphQL query: "{ users { friends { createdAt } }"
$decorators->path('users.friends.createdAt', function (...) { ... });

Type-hint

"Type-hint" decorators must respond to the type matching in the declaration and the return result (using the instanceof operator).

Example:

// Processing the all fields which return a type that is one of the `DateTimeInterface` children.
$decorator->type(\DateTimeInterface::class, function (...) { ... });

This package does not provide the code of the psr/container package (which defines interfaces). It provides psr/container-implementation which is the virtual package representing implementations of the interface. Providing the wrong package while also requiring it creates issues with Composer 2, because the solver will consider that installing psr/container is not necessary as it is already provided.

Refs composer/composer#9316

Hello,

We are currently choosing GraphQL library for our project and railt looks really promising. Its well written and modern, but English documentation is rally missing !

We dont need perfect documentation which covers every single detail, but at least a simple example and few words for each class, so you can easily know what to do, how to use it, and also compare this library with competing ones and choose the right one for you.

Thank you.

Hi, I'm making updates for Open Collective. Either you or another core contributor signed this repository up for Open Collective. This pull request adds financial contributors from your Open Collective https://opencollective.com/railt ❤️

What it does:

• adds a badge to show the latest number of financial contributors
• adds a banner displaying contributors to the project on GitHub
• adds a banner displaying all individuals contributing financially on Open Collective
• adds a section displaying all organizations contributing financially on Open Collective, with their logo and a link to their website

P.S: As with any pull request, feel free to comment or suggest changes.

Thank you for your great contribution to the Open Source community. You are awesome! 🙌 And welcome to the Open Collective community! 😊

Come chat with us in the #opensource channel on https://slack.opencollective.com - great place to ask questions and share best practices with other Open Source sustainers!

Hello. When a field are resolved by the controller, and the field type is a list, the result must to be a list of arrays, otherwise, if I return a list of objects (that can be accessible by using array annotation, because in my try I've implemented the arrayaccess interface), the values of the fields in the response are null, Railt don't resolve correctly.

For example:

class UserController{
 public function listAll() {
  $users = Users::findAll(); //returns a list of Users object that implement ArrayAccess interface and extends the Model class
  $r = [] 
  foreach($users as $u) {
   $r["name"] = $u["name"];
   $r["login"] = $u["login"];
  } 
  return $r
 } 

} 

This works, but if I try to return the users directly like this

class UserController{
 public function listAll() {
  $users = Users::findAll(); //returns a list of Users object that implement ArrayAccess interface and extends the Model class
  
  return $users
 } 

} 

The result is something like this (it's just a example, ignore the json malformed) :

{
 user:{
   "name": null
    "login": null
 }, {
   "name": null
    "login": null
 }, {
   "name": null
    "login": null
 }, 

} 

A list of null field values.

Is there a way to tell Railt how to properly resolve that? Or, can I make railt able to handle with custom objects in results? Railt: 1.4.x

Bumps symfony/http-kernel from 4.4.3 to 4.4.13.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

I'd like to use the Deffer feature of webonyx, how can i do this in rait?

<?php
'resolve' => function($blogStory) {
    MyUserBuffer::add($blogStory['authorId']);

    return new GraphQL\Deferred(function () use ($blogStory) {
        MyUserBuffer::loadBuffered();
        return MyUserBuffer::get($blogStory['authorId']);
    });
}

solving-n1-problem

Expected Behavior

I want to validate the whole input data.

What happens instead?

{ "code": 0, "error": "(Railt\SDL\Exceptions\TypeNotFoundException) Type "validate" not found and could not be loaded", "file": "At /Users/vidy/www/discovery/app/graphql/comment.graphql line 10", "trace": "#0 /Users/vidy/www/discovery/vendor/railt/railt/src/SDL/Reflection/Loader.php(72)" }

Steps To Reproduce

@use(class: "App\\Controller\\Admin\\CommentController")
@use(class: "App\\Validator\\CommentValidator", as: "Comment")

type Mutation {
    """
    创建评论
    """
    createComment(
      input: CommentInput!
    ): Comment!
      @route(action: "CommentController@create")
      @validate(use: "Comment")
}

input CommentInput {
   """评论正文"""
  comment: String!
  """父评论ID"""
  parent_id: ID
}

type Comment {
  id: ID!
}

Required for the reflection component

1. To review the hierarchy of classes (contracts).
2. Сompletely cover with the tests a new structure of reflection (48% more required).

I think that it's worth implementing support for custom values for enum

Example:

type User {
  updatedAt(format: DateTimeFormat = RFC3339): DateTime!
  createdAt(format: DateTimeFormat = RFC3339): DateTime!
}

enum DateTimeFormat {
    RFC3339: "Y-m-d\TH:i:sO"
    ISO8601: "Y-m-d\TH:i:sP"
}

What do you think about this?