Skip to content

Update documentation to remove deprecated methods #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dondonz merged 5 commits into from
Jan 9, 2025
Merged

Update documentation to remove deprecated methods #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2229aef
Update concerns page to use GraphQLContext
dondonz Dec 18, 2024
c9b24ab
Update SDL example to use GraphQLContext
dondonz Dec 18, 2024
8e6a198
Update datafetching examples to use GraphQLContext
dondonz Dec 18, 2024
99c36dd
Clarify context is now a map
dondonz Dec 18, 2024
f66f8e8
Replace deprecated directive method
dondonz Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/concerns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This made up example shows how you can pass yourself information to help execute
UserContext contextForUser = YourGraphqlContextBuilder.getContextForUser(getCurrentUser());

ExecutionInput executionInput = ExecutionInput.newExecutionInput()
.context(contextForUser)
.graphQLContext(context -> context.put("userContext", contextForUser))
.build();

ExecutionResult executionResult = graphQL.execute(executionInput);
Expand All @@ -57,7 +57,7 @@ ExecutionResult executionResult = graphQL.execute(executionInput);
DataFetcher dataFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
UserContext userCtx = environment.getContext();
UserContext userCtx = environment.getGraphQlContext().get("userContext");
Long businessObjId = environment.getArgument("businessObjId");

return invokeBusinessLayerMethod(userCtx, businessObjId);
Expand Down
11 changes: 5 additions & 6 deletions documentation/data-fetching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ It might look like the following :
DataFetcher productsDataFetcher = new DataFetcher<List<ProductDTO>>() {
@Override
public List<ProductDTO> get(DataFetchingEnvironment environment) {
DatabaseSecurityCtx ctx = environment.getContext();
DatabaseSecurityCtx ctx = environment.getGraphQlContext().get("databaseSecurityCtx");

List<ProductDTO> products;
String match = environment.getArgument("match");
Expand All @@ -62,7 +62,7 @@ Each ``DataFetcher`` is passed a ``graphql.schema.DataFetchingEnvironment`` obje
arguments have been supplied to the field and other information such as the field's type, its parent type, the query root object or the query
context object.

Note how the data fetcher code above uses the ``context`` object as an application specific security handle to get access
Note how the data fetcher code above uses the context object as an application specific security handle to get access
to the database. This is a common technique to provide lower layer calling context.

Once we have a list of ``ProductDTO`` objects we typically don't need specialised data fetchers on each field. graphql-java
Expand Down Expand Up @@ -146,14 +146,13 @@ top level fields. The root object never changes during the query and it may be
arguments that have been resolved from passed in variables, AST literals and default argument values. You use the arguments
of a field to control what values it returns.

* ``<T> T getContext()`` - the context object is set up when the query is first executed and stays the same over the lifetime
of the query. The context can be any value and is typically used to give each data fetcher some calling context needed
* ``<T> T getGraphQLContext()`` - the context object is set up when the query is first executed and stays the same over the lifetime
of the query. The context is a map that can contain any value and is typically used to give each data fetcher some calling context needed
when trying to get field data. For example the current user credentials or the database connection parameters could be contained
with a ``context`` object so that data fetchers can make business layer calls. One of the key design decisions you have as a graphql
with a context object so that data fetchers can make business layer calls. One of the key design decisions you have as a graphql
system designer is how you will use context in your fetchers if at all. Some people use a dependency framework that injects context into
data fetchers automatically and hence don't need to use this.


* ``ExecutionStepInfo getExecutionStepInfo()`` - the field type information is a catch all bucket of field type information that is built up as
the query is executed. The following section explains more on this.

Expand Down
7 changes: 3 additions & 4 deletions documentation/sdl-directives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class AuthorisationDirective implements SchemaDirectiveWiring {

@Override
public GraphQLFieldDefinition onField(SchemaDirectiveWiringEnvironment<GraphQLFieldDefinition> environment) {
String targetAuthRole = (String) environment.getDirective().getArgument("role").getArgumentValue().getValue();
String targetAuthRole = (String) environment.getAppliedDirective().getArgument("role").getArgumentValue().getValue();

//
// build a data fetcher that first checks authorisation roles before then calling the original data fetcher
Expand All @@ -84,8 +84,7 @@ class AuthorisationDirective implements SchemaDirectiveWiring {
DataFetcher authDataFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment dataFetchingEnvironment) throws Exception {
Map<String, Object> contextMap = dataFetchingEnvironment.getContext();
AuthorisationCtx authContext = (AuthorisationCtx) contextMap.get("authContext");
AuthorisationCtx authContext = dataFetchingEnvironment.getGraphQlContext().get("authContext");

if (authContext.hasRole(targetAuthRole)) {
return originalDataFetcher.get(dataFetchingEnvironment);
Expand Down Expand Up @@ -119,7 +118,7 @@ AuthorisationCtx authCtx = AuthorisationCtx.obtain();

ExecutionInput executionInput = ExecutionInput.newExecutionInput()
.query(query)
.context(authCtx)
.graphQLContext(builder -> builder.put("authContext", authCtx))
.build();
```

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-v22/concerns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This made up example shows how you can pass yourself information to help execute
UserContext contextForUser = YourGraphqlContextBuilder.getContextForUser(getCurrentUser());

ExecutionInput executionInput = ExecutionInput.newExecutionInput()
.context(contextForUser)
.graphQLContext(context -> context.put("userContext", contextForUser))
.build();

ExecutionResult executionResult = graphQL.execute(executionInput);
Expand All @@ -57,7 +57,7 @@ ExecutionResult executionResult = graphQL.execute(executionInput);
DataFetcher dataFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment environment) {
UserContext userCtx = environment.getContext();
UserContext userCtx = environment.getGraphQlContext().get("userContext");
Long businessObjId = environment.getArgument("businessObjId");

return invokeBusinessLayerMethod(userCtx, businessObjId);
Expand Down
89 changes: 44 additions & 45 deletions versioned_docs/version-v22/data-fetching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,27 +42,27 @@ It might look like the following :

```java
DataFetcher productsDataFetcher = new DataFetcher<List<ProductDTO>>() {
@Override
public List<ProductDTO> get(DataFetchingEnvironment environment) {
DatabaseSecurityCtx ctx = environment.getContext();

List<ProductDTO> products;
String match = environment.getArgument("match");
if (match != null) {
products = fetchProductsFromDatabaseWithMatching(ctx, match);
} else {
products = fetchAllProductsFromDatabase(ctx);
}
return products;
@Override
public List<ProductDTO> get(DataFetchingEnvironment environment) {
DatabaseSecurityCtx ctx = environment.getGraphQlContext().get("databaseSecurityCtx");

List<ProductDTO> products;
String match = environment.getArgument("match");
if (match != null) {
products = fetchProductsFromDatabaseWithMatching(ctx, match);
} else {
products = fetchAllProductsFromDatabase(ctx);
}
return products;
}
};
```

Each ``DataFetcher`` is passed a ``graphql.schema.DataFetchingEnvironment`` object which contains what field is being fetched, what
arguments have been supplied to the field and other information such as the field's type, its parent type, the query root object or the query
context object.

Note how the data fetcher code above uses the ``context`` object as an application specific security handle to get access
Note how the data fetcher code above uses the context object as an application specific security handle to get access
to the database. This is a common technique to provide lower layer calling context.

Once we have a list of ``ProductDTO`` objects we typically don't need specialised data fetchers on each field. graphql-java
Expand All @@ -80,25 +80,25 @@ argument. We can have the ProductDTO have logic that applies this date formatti
```java
class ProductDTO {

private ID id;
private String name;
private String description;
private Double cost;
private Double tax;
private LocalDateTime launchDate;
private ID id;
private String name;
private String description;
private Double cost;
private Double tax;
private LocalDateTime launchDate;

// ...
// ...

public String getName() {
return name;
}
public String getName() {
return name;
}

// ...
// ...

public String getLaunchDate(DataFetchingEnvironment environment) {
String dateFormat = environment.getArgument("dateFormat");
return yodaTimeFormatter(launchDate,dateFormat);
}
public String getLaunchDate(DataFetchingEnvironment environment) {
String dateFormat = environment.getArgument("dateFormat");
return yodaTimeFormatter(launchDate,dateFormat);
}
}
```

Expand Down Expand Up @@ -135,33 +135,32 @@ Every data fetcher is passed a ``graphql.schema.DataFetchingEnvironment`` object
and what arguments have been provided. Here are some of the more interesting parts of ``DataFetchingEnvironment``.

* ``<T> T getSource()`` - the ``source`` object is used to get information for a field. Its the object that is the result
of the parent field fetch. In the common case it is an in memory DTO object and hence simple POJO getters will be used for fields values. In more complex cases, you may examine it to know
how to get the specific information for the current field. As the graphql field tree is executed, each returned field value
becomes the ``source`` object for child fields.
of the parent field fetch. In the common case it is an in memory DTO object and hence simple POJO getters will be used for fields values. In more complex cases, you may examine it to know
how to get the specific information for the current field. As the graphql field tree is executed, each returned field value
becomes the ``source`` object for child fields.

* ``<T> T getRoot()`` - this special object is used to seed the graphql query. The ``root`` and the ``source`` is the same thing for the
top level fields. The root object never changes during the query and it may be null and hence no used.
top level fields. The root object never changes during the query and it may be null and hence no used.

* ``Map<String, Object> getArguments()`` - this represents the arguments that have been provided on a field and the values of those
arguments that have been resolved from passed in variables, AST literals and default argument values. You use the arguments
of a field to control what values it returns.

* ``<T> T getContext()`` - the context object is set up when the query is first executed and stays the same over the lifetime
of the query. The context can be any value and is typically used to give each data fetcher some calling context needed
when trying to get field data. For example the current user credentials or the database connection parameters could be contained
with a ``context`` object so that data fetchers can make business layer calls. One of the key design decisions you have as a graphql
system designer is how you will use context in your fetchers if at all. Some people use a dependency framework that injects context into
data fetchers automatically and hence don't need to use this.
arguments that have been resolved from passed in variables, AST literals and default argument values. You use the arguments
of a field to control what values it returns.

* ``<T> T getGraphQLContext()`` - the context object is set up when the query is first executed and stays the same over the lifetime
of the query. The context is a map that can contain any value and is typically used to give each data fetcher some calling context needed
when trying to get field data. For example the current user credentials or the database connection parameters could be contained
with a context object so that data fetchers can make business layer calls. One of the key design decisions you have as a graphql
system designer is how you will use context in your fetchers if at all. Some people use a dependency framework that injects context into
data fetchers automatically and hence don't need to use this.

* ``ExecutionStepInfo getExecutionStepInfo()`` - the field type information is a catch all bucket of field type information that is built up as
the query is executed. The following section explains more on this.
the query is executed. The following section explains more on this.

* ``DataFetchingFieldSelectionSet getSelectionSet()`` - the selection set represents the child fields that have been "selected" under neath the
currently executing field. This can be useful to help look ahead to see what sub field information a client wants. The following section explains more on this.
currently executing field. This can be useful to help look ahead to see what sub field information a client wants. The following section explains more on this.

* ``ExecutionId getExecutionId()`` - each query execution is given a unique id. You can use this perhaps on logs to tag each individual
query.
query.

## The interesting parts of ExecutionStepInfo

Expand All @@ -183,7 +182,7 @@ query {
name
description
sellingLocations {
state
state
}
}
}
Expand Down
7 changes: 3 additions & 4 deletions versioned_docs/version-v22/sdl-directives.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ class AuthorisationDirective implements SchemaDirectiveWiring {

@Override
public GraphQLFieldDefinition onField(SchemaDirectiveWiringEnvironment<GraphQLFieldDefinition> environment) {
String targetAuthRole = (String) environment.getDirective().getArgument("role").getArgumentValue().getValue();
String targetAuthRole = (String) environment.getAppliedDirective().getArgument("role").getArgumentValue().getValue();

//
// build a data fetcher that first checks authorisation roles before then calling the original data fetcher
Expand All @@ -84,8 +84,7 @@ class AuthorisationDirective implements SchemaDirectiveWiring {
DataFetcher authDataFetcher = new DataFetcher() {
@Override
public Object get(DataFetchingEnvironment dataFetchingEnvironment) throws Exception {
Map<String, Object> contextMap = dataFetchingEnvironment.getContext();
AuthorisationCtx authContext = (AuthorisationCtx) contextMap.get("authContext");
AuthorisationCtx authContext = dataFetchingEnvironment.getGraphQlContext().get("authContext");

if (authContext.hasRole(targetAuthRole)) {
return originalDataFetcher.get(dataFetchingEnvironment);
Expand Down Expand Up @@ -119,7 +118,7 @@ AuthorisationCtx authCtx = AuthorisationCtx.obtain();

ExecutionInput executionInput = ExecutionInput.newExecutionInput()
.query(query)
.context(authCtx)
.graphQLContext(builder -> builder.put("authContext", authCtx))
.build();
```

Expand Down