Custom Directive

[deweyjose]

Hi,

I’m looking for guidance on adding custom directives. We used to do something like this

class AuthDirective implements SchemaDirectiveWiring {
...:
}

RuntimeWiring.newRuntimeWiring()
.directive("auth", new AuthDirective())
.build();

Not sure exactly how to achieve this in DGS. Any thoughts?

[deweyjose]

I found @DgsRuntimeWiring.

[srinivasankavitha]

Ok, I think I understand better now. You are specifically asking for an out-of-the-box implementation of some general purpose directives, such as @DgsRateLimit, @QueryLimit etc?

[sbilello]

Yes!
I was looking at this post https://leapgraph.com/graphql-api-security/
where most of the libraries are implemented in javascript. I thought that I
should add such support to my graphql service to be robust and avoid
malicious developers bringing it down because I didn't cover all these
security/reliability aspects for every single graph.
Thank you very much for your time!

[deweyjose]

@srinivasankavitha @sbilello just to be clear - am not suggesting adding what I am doing to any of the codegen functionality or even to the core dgs framework. authn/z is complicated and opinionated, best left up to users to figure out the best approach. By generalize I meant for our projects - refactor the code I listed into a library and give users the ability to provide an auth provider Bean that it can call - independent of anything DGS. @sbilello asked how I was able to inherit directives from parent to child fields, just providing that, not suggesting anything for DGS.

@srinivasankavitha - We could let the DataFetchers handle authz., However that means each Datafetcher needs to do Authz. Rather than add boiler plate to the DataFetchers why not handle it in a centralized place? Similar to graphql-shield in the NodeJS ecosystem.

[srinivasankavitha]

Thanks for the explanation and context @deweyjose. That makes sense.

[hantsy]

I do not need to get value from the directive,

eg. applying an uppercase just transform to upper case.

Register it in the RuntimeWiring, it does not work.

[ankit-joinwal]

Here is a working example i created to use custom directives with Netflix DGS.
https://github.com/ankit-joinwal/netflix-dgs-authorisation-directives

[hantsy]

I have tried to use RuntimeWiring.Builder to register a directive, failed.

Check issue: #419

and my sample project: https://github.com/hantsy/spring-graphql-sample/tree/master/dgs-codegen

[WtfJoke]

@hantsy it works... You had just a small error it works if you change your CustomRuntimeWiring to following:

@DgsComponent
public class CustomRuntimeWiring {

    private final UppercaseDirectiveWiring uppercaseDirectiveWiring;

    public CustomRuntimeWiring(UppercaseDirectiveWiring uppercaseDirectiveWiring){
        this.uppercaseDirectiveWiring = uppercaseDirectiveWiring;
    }

    @DgsRuntimeWiring
    public RuntimeWiring.Builder customRuntimeWiring(RuntimeWiring.Builder builder) {
        return builder.directive("uppercase", uppercaseDirectiveWiring);
    }
}

[hantsy]

Thanks @WtfJoke

[WtfJoke]

I've also build a basic example how to use custom directives with Netflix DGS:
https://github.com/WtfJoke/graphql-dgs-directives-demo

[hantsy]

I am trying to send a PR to support a @DgsDirective to declare a directive directly, please review it.

[WtfJoke]

I did and left some feebdack, however im not a contributor to this project 😅