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

feat: add paused for subscriptions init object #143

Merged
merged 2 commits into from
Oct 18, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/villus/src/Subscription.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import { defineComponent, toRef, VNode, watch } from 'vue';
import { normalizeChildren } from './utils';
import { normalizeChildren, CombinedError } from './utils';
import { useSubscription, defaultReducer, Reducer } from './useSubscription';
import { CombinedError } from '../dist/villus';

interface SubscriptionSlotProps {
data: unknown;
Expand Down Expand Up @@ -36,6 +35,7 @@ const SubscriptionImpl = defineComponent({
{
query: props.query as string,
variables: props.variables as Record<string, any> | undefined,
paused: props.paused,
},
(props.reduce as Reducer) || defaultReducer
);
Expand Down
17 changes: 12 additions & 5 deletions packages/villus/src/useSubscription.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,15 @@ import { Operation } from '../../shared/src';
interface SubscriptionCompositeOptions<TData, TVars> {
query: MaybeRef<Operation<TData, TVars>['query']>;
variables?: MaybeRef<TVars>;
paused?: boolean;
}

export type Reducer<TData = any, TResult = TData> = (prev: TResult | null, value: OperationResult<TData>) => TResult;

export const defaultReducer: Reducer = (_, val) => val.data;

export function useSubscription<TData = any, TResult = TData, TVars = QueryVariables>(
{ query, variables }: SubscriptionCompositeOptions<TData, TVars>,
{ query, variables, paused }: SubscriptionCompositeOptions<TData, TVars>,
reduce: Reducer<TData, TResult> = defaultReducer
) {
const client = injectWithSelf(VILLUS_CLIENT, () => {
Expand All @@ -23,7 +24,7 @@ export function useSubscription<TData = any, TResult = TData, TVars = QueryVaria

const data = ref<TResult | null>(reduce(null, { data: null, error: null }));
const error: Ref<CombinedError | null> = ref(null);
const isPaused = ref(false);
const isPaused = ref(paused || false);

function handleResponse(result: OperationResult<TData>) {
data.value = reduce(data.value as TResult, result) as any;
Expand Down Expand Up @@ -63,9 +64,11 @@ export function useSubscription<TData = any, TResult = TData, TVars = QueryVaria
}

let observer: Unsubscribable;
onMounted(async () => {
observer = await initObserver();
});
if (!paused) {
onMounted(async () => {
observer = await initObserver();
});
}

onBeforeUnmount(() => {
if (observer) {
Expand All @@ -78,6 +81,10 @@ export function useSubscription<TData = any, TResult = TData, TVars = QueryVaria
}

async function resume() {
if (!observer) {
reInit();
}

isPaused.value = false;
}

Expand Down
48 changes: 48 additions & 0 deletions packages/villus/test/useSubscription.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,54 @@ test('Pauses and resumes subscriptions', async () => {
expect(document.querySelector('#status')?.textContent).toBe('false');
});

test('Can pause subscriptions initially', async () => {
mount({
setup() {
useClient({
url: 'https://test.com/graphql',
use: [handleSubscriptions(() => makeObservable()), ...defaultPlugins()],
});

function reduce(oldMessages: string[] | null, response: any) {
if (!response.data || !oldMessages) {
return oldMessages || [];
}

return [...oldMessages, response.data.message];
}

const { data, resume, isPaused } = useSubscription(
{ query: `subscription { newMessages }`, paused: true },
reduce
);

return { messages: data, resume, isPaused };
},
template: `
<div>
<ul v-for="message in messages">
<li>{{ message.id }}</li>
</ul>
<button @click="resume"></button>
<span id="status">{{ isPaused }}</span>
</div>
`,
});

await flushPromises();
jest.advanceTimersByTime(201);
// pauses subscription
expect(document.querySelector('#status')?.textContent).toBe('true');
jest.advanceTimersByTime(201);
expect(document.querySelectorAll('li')).toHaveLength(0);
document.querySelector('button')?.dispatchEvent(new Event('click'));
await flushPromises();
expect(document.querySelector('#status')?.textContent).toBe('false');
jest.advanceTimersByTime(201);
await flushPromises();
expect(document.querySelectorAll('li')).toHaveLength(2);
});

test('Fails if provider was not resolved', () => {
try {
mount({
Expand Down