Skip to content
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.

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

fix race conditions related to introspection prop #342

Merged
merged 1 commit into from
Aug 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 16 additions & 14 deletions src/components/Voyager.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import {

import { getTypeGraph } from '../graph/';
import { extractTypeName, getSchema, typeNameToId } from '../introspection';
import { MaybePromise, usePromise } from '../utils/usePromise';
import DocExplorer from './doc-explorer/DocExplorer';
import GraphViewport from './GraphViewport';
import { IntrospectionModal } from './IntrospectionModal';
Expand All @@ -37,7 +38,9 @@ export interface VoyagerDisplayOptions {
}

export interface VoyagerProps {
introspection: Promise<ExecutionResult<IntrospectionQuery> | GraphQLSchema>;
introspection?: MaybePromise<
ExecutionResult<IntrospectionQuery> | GraphQLSchema
>;
displayOptions?: VoyagerDisplayOptions;
introspectionPresets?: { [name: string]: any };
allowToChangeSchema?: boolean;
Expand All @@ -62,29 +65,28 @@ export default function Voyager(props: VoyagerProps) {
[props.displayOptions],
);

const [introspectionModalOpen, setIntrospectionModalOpen] = useState(false);
const [introspectionResult, setIntrospectionResult] = useState(null);
const [introspectionModalOpen, setIntrospectionModalOpen] = useState(
props.introspection == null,
);
const [introspectionResult, resolveIntrospectionResult] = usePromise(
props.introspection,
);
const [displayOptions, setDisplayOptions] = useState(initialDisplayOptions);

useEffect(() => {
// FIXME: handle rejection and also handle errors inside introspection
// eslint-disable-next-line @typescript-eslint/no-floating-promises
Promise.resolve(props.introspection).then(setIntrospectionResult);
}, [props.introspection]);

useEffect(() => {
setDisplayOptions(initialDisplayOptions);
}, [introspectionResult, initialDisplayOptions]);

const typeGraph = useMemo(() => {
if (introspectionResult == null) {
if (introspectionResult.loading || introspectionResult.value == null) {
// FIXME: display introspectionResult.error
return null;
}

const introspectionSchema =
introspectionResult instanceof GraphQLSchema
? introspectionResult
: buildClientSchema(introspectionResult.data);
introspectionResult.value instanceof GraphQLSchema
? introspectionResult.value
: buildClientSchema(introspectionResult.value.data);

const schema = getSchema(
introspectionSchema,
Expand Down Expand Up @@ -133,7 +135,7 @@ export default function Voyager(props: VoyagerProps) {
open={introspectionModalOpen}
presets={props.introspectionPresets}
onClose={() => setIntrospectionModalOpen(false)}
onChange={setIntrospectionResult}
onChange={resolveIntrospectionResult}
/>
);
}
Expand Down
54 changes: 54 additions & 0 deletions src/utils/usePromise.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
import { useCallback, useEffect, useState } from 'react';

type PromiseState<T> =
| { loading: true; error: null; value: undefined }
| { loading: false; error: null; value: T }
| { loading: false; error: unknown; value: undefined };

export type MaybePromise<T> = Promise<T> | T;

export function usePromise<T>(
maybePromise: MaybePromise<T>,
): [PromiseState<T>, (value: T) => void] {
const [state, setState] = useState<PromiseState<T>>({
loading: true,
error: null,
value: undefined,
});

useEffect(() => {
let isMounted = true;

setState({ loading: true, error: null, value: undefined });
Promise.resolve(maybePromise).then(
(value) => {
if (isMounted) {
setState((oldState) =>
oldState.loading // update only if unresolved
? { loading: false, error: null, value }
: oldState,
);
}
},
(error) => {
if (isMounted) {
setState((oldState) =>
oldState.loading // update only if unresolved
? { loading: false, error, value: undefined }
: oldState,
);
}
},
);

return () => {
isMounted = false;
};
}, [maybePromise]);

const resolveValue = useCallback((value: T) => {
setState({ loading: false, error: null, value });
}, []);

return [state, resolveValue];
}