8000 Better javadoc on beginFieldFetching by bbakerman · Pull Request #3610 · graphql-java/graphql-java · GitHub
[go: up one dir, main page]
Skip to content

Better javadoc on beginFieldFetching #3610

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
bbakerman merged 1 commit into from
Jun 1, 2024
Merged

Better javadoc on beginFieldFetching #3610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
39 changes: 20 additions & 19 deletions src/main/java/graphql/execution/instrumentation/FieldFetchingInstrumentationContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,30 @@

import graphql.Internal;
import graphql.PublicSpi;
import graphql.execution.instrumentation.parameters.InstrumentationFieldFetchParameters;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

/**
* FieldFetchingInstrumentationContext is returned back from the {@link Instrumentation#beginFieldFetching(InstrumentationFieldFetchParameters, InstrumentationState)}
* method, and it's much like the normal {@link InstrumentationContext} type except it also
* gives the value that was returned by a fields {@link graphql.schema.DataFetcher}. This allows
* you to know if the field value is a completely materialised field or if it's a {@link java.util.concurrent.CompletableFuture}
* promise to a value.
*/
@PublicSpi
public interface FieldFetchingInstrumentationContext extends InstrumentationContext<Object> {

/**
* This is called back with the value fetched for the field by its {@link graphql.schema.DataFetcher}.
* This can be a materialised java object or it maybe a {@link java.util.concurrent.CompletableFuture}
* promise to some async value that has not yet completed.
*
* @param fetchedValue a value that a field's {@link graphql.schema.DataFetcher} returned
*/
default void onFetchedValue(Object fetchedValue) {
}

@Internal
FieldFetchingInstrumentationContext NOOP = new FieldFetchingInstrumentationContext() {
@Override
Expand All @@ -17,18 +35,13 @@ public void onDispatched() {
@Override
public void onCompleted(Object result, Throwable t) {
}

@Override
public void onFetchedValue(Object fetchedValue) {
}
Copy link
Member Author
@bbakerman bbakerman Jun 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we never needed because it is a default method on the interface

};

/**
* This creates a no-op {@link InstrumentationContext} if the one pass in is null
* This creates a no-op {@link InstrumentationContext} if the one passed in is null
*
* @param nullableContext a {@link InstrumentationContext} that can be null
*
* @return a non null {@link InstrumentationContext} that maybe a no-op
* @return a non-null {@link InstrumentationContext} that maybe a no-op
*/
@NotNull
@Internal
Expand All @@ -51,18 +64,6 @@ public void onDispatched() {
public void onCompleted(Object result, Throwable t) {
context.onCompleted(result, t);
}

@Override
public void onFetchedValue(Object fetchedValue) {
}
};
}

/**
* This is called back with value fetched for the field.
*
* @param fetchedValue a value that a field's {@link graphql.schema.DataFetcher} returned
*/
default void onFetchedValue(Object fetchedValue) {
}
Copy link
Member Author
@bbakerman bbakerman Jun 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a bit of field re-ordering

}
5 changes: 5 additions & 0 deletions src/main/java/graphql/execution/instrumentation/Instrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,11 @@ default InstrumentationContext<Object> beginFieldFetch(InstrumentationFieldFetch
* This is called just before a field {@link DataFetcher} is invoked. The {@link FieldFetchingInstrumentationContext#onFetchedValue(Object)}
* callback will be invoked once a value is returned by a {@link DataFetcher} but perhaps before
* its value is completed if it's a {@link CompletableFuture} value.
* <p>
* This method is the replacement method for the now deprecated {@link #beginFieldFetch(InstrumentationFieldFetchParameters, InstrumentationState)}
* method, and it should be implemented in new {@link Instrumentation} classes. This default version of this
* method calls back to the deprecated {@link #beginFieldFetch(InstrumentationFieldFetchParameters, InstrumentationState)} method
* so that older implementations continue to work.
*
* @param parameters the parameters to this step
* @param state the state created during the call to {@link #createStateAsync(InstrumentationCreateStateParameters)}
Expand Down
0