commit 068df71f65506445e26e5b57366bae691a6c3554 · kitten.sh/urql

.changeset/chatty-mice-join.md

···

       1
       1
       +
       ---

     

       2
       2
       +
       '@urql/vue': minor

     

       3
       3
       +
       ---

     

       4
       4
       +
       

     

       5
       5
       +
       Refactor composable functions with a focus on avoiding memory leaks and Vue best practices

+3 -4

packages/vue-urql/src/useClientHandle.ts

···

       1
       1
       -
       import type { DocumentNode } from 'graphql';

     

       2
       2
       -
       import type { AnyVariables, Client, TypedDocumentNode } from '@urql/core';

     

       1
       1
       +
       import type { AnyVariables, Client, DocumentInput } from '@urql/core';

     

       3
       2
        
       import type { WatchStopHandle } from 'vue';

     

       4
       3
        
       import { getCurrentInstance, onMounted, onBeforeUnmount } from 'vue';

     

       5
       4
        
       

     
···

       75
       74
        
          * function or when chained in an `async setup()` function.

     

       76
       75
        
          */

     

       77
       76
        
         useMutation<T = any, V extends AnyVariables = AnyVariables>(

     

       78
       78
       -
           query: TypedDocumentNode<T, V> | DocumentNode | string

     

       77
       77
       +
           query: DocumentInput<T, V>

     

       79
       78
        
         ): UseMutationResponse<T, V>;

     

       80
       79
        
       }

     

       81
       80
        
       

     
···

       153
       152
        
           },

     

       154
       153
        
       

     

       155
       154
        
           useMutation<T = any, V extends AnyVariables = AnyVariables>(

     

       156
       156
       -
             query: TypedDocumentNode<T, V> | DocumentNode | string

     

       155
       155
       +
             query: DocumentInput<T, V>

     

       157
       156
        
           ): UseMutationResponse<T, V> {

     

       158
       157
        
             return callUseMutation(query, client);

     

       159
       158
        
           },

+16 -18

packages/vue-urql/src/useMutation.test.ts

···

       1
       1
        
       import { OperationResult, OperationResultSource } from '@urql/core';

     

       2
       2
       -
       import { reactive } from 'vue';

     

       2
       2
       +
       import { readonly } from 'vue';

     

       3
       3
        
       import { vi, expect, it, beforeEach, describe } from 'vitest';

     

       4
       4
        
       

     

       5
       5
        
       vi.mock('./useClient.ts', async () => {

     
···

       30
       30
        
               () => subject.source as OperationResultSource<OperationResult>

     

       31
       31
        
             );

     

       32
       32
        
       

     

       33
       33
       -
           const mutation = reactive(

     

       34
       34
       -
             useMutation(gql`

     

       35
       35
       -
               mutation {

     

       36
       36
       -
                 test

     

       37
       37
       -
               }

     

       38
       38
       -
             `)

     

       39
       39
       -
           );

     

       33
       33
       +
           const mutation = useMutation(gql`

     

       34
       34
       +
             mutation {

     

       35
       35
       +
               test

     

       36
       36
       +
             }

     

       37
       37
       +
           `);

     

       40
       38
        
       

     

       41
       41
       -
           expect(mutation).toMatchObject({

     

       39
       39
       +
           expect(readonly(mutation)).toMatchObject({

     

       42
       40
        
             data: undefined,

     

       43
       41
        
             stale: false,

     

       44
       42
        
             fetching: false,

     
···

       50
       48
        
       

     

       51
       49
        
           const promise = mutation.executeMutation({ test: true });

     

       52
       50
        
       

     

       53
       53
       -
           expect(mutation.fetching).toBe(true);

     

       54
       54
       -
           expect(mutation.stale).toBe(false);

     

       55
       55
       -
           expect(mutation.error).toBe(undefined);

     

       51
       51
       +
           expect(mutation.fetching.value).toBe(true);

     

       52
       52
       +
           expect(mutation.stale.value).toBe(false);

     

       53
       53
       +
           expect(mutation.error.value).toBe(undefined);

     

       56
       54
        
       

     

       57
       55
        
           expect(clientMutation).toHaveBeenCalledTimes(1);

     

       58
       56
        
       

     

       59
       57
        
           subject.next({ data: { test: true }, stale: false });

     

       60
       60
       -
           await promise.then(function () {

     

       61
       61
       -
             expect(mutation.fetching).toBe(false);

     

       62
       62
       -
             expect(mutation.stale).toBe(false);

     

       63
       63
       -
             expect(mutation.error).toBe(undefined);

     

       64
       64
       -
             expect(mutation.data).toEqual({ test: true });

     

       65
       65
       -
           });

     

       58
       58
       +
       

     

       59
       59
       +
           await promise;

     

       60
       60
       +
           expect(mutation.fetching.value).toBe(false);

     

       61
       61
       +
           expect(mutation.stale.value).toBe(false);

     

       62
       62
       +
           expect(mutation.error.value).toBe(undefined);

     

       63
       63
       +
           expect(mutation.data.value).toHaveProperty('test', true);

     

       66
       64
        
         });

     

       67
       65
        
       });

+11 -13

packages/vue-urql/src/useMutation.ts

···

       1
       1
        
       /* eslint-disable react-hooks/rules-of-hooks */

     

       2
       2
        
       

     

       3
       3
        
       import type { Ref } from 'vue';

     

       4
       4
       -
       import { ref, shallowRef } from 'vue';

     

       5
       5
       -
       import type { DocumentNode } from 'graphql';

     

       4
       4
       +
       import { ref } from 'vue';

     

       6
       5
        
       import { pipe, onPush, filter, toPromise, take } from 'wonka';

     

       7
       6
        
       

     

       8
       7
        
       import type {

     

       9
       8
        
         Client,

     

       10
       9
        
         AnyVariables,

     

       11
       11
       -
         TypedDocumentNode,

     

       12
       10
        
         CombinedError,

     

       13
       11
        
         Operation,

     

       14
       12
        
         OperationContext,

     

       15
       13
        
         OperationResult,

     

       14
       14
       +
         DocumentInput,

     

       16
       15
        
       } from '@urql/core';

     

       17
       17
       -
       import { createRequest } from '@urql/core';

     

       18
       16
        
       

     

       19
       17
        
       import { useClient } from './useClient';

     

       20
       18
        
       import type { MaybeRef } from './utils';

     

       21
       21
       -
       import { unref } from './utils';

     

       19
       19
       +
       import { createRequestWithArgs, useRequestState } from './utils';

     

       22
       20
        
       

     

       23
       21
        
       /** State of the last mutation executed by {@link useMutation}.

     

       24
       22
        
        *

     
···

       126
       124
        
        * ```

     

       127
       125
        
        */

     

       128
       126
        
       export function useMutation<T = any, V extends AnyVariables = AnyVariables>(

     

       129
       129
       -
         query: TypedDocumentNode<T, V> | DocumentNode | string

     

       127
       127
       +
         query: DocumentInput<T, V>

     

       130
       128
        
       ): UseMutationResponse<T, V> {

     

       131
       129
        
         return callUseMutation(query);

     

       132
       130
        
       }

     

       133
       131
        
       

     

       134
       132
        
       export function callUseMutation<T = any, V extends AnyVariables = AnyVariables>(

     

       135
       135
       -
         query: MaybeRef<TypedDocumentNode<T, V> | DocumentNode | string>,

     

       133
       133
       +
         query: MaybeRef<DocumentInput<T, V>>,

     

       136
       134
        
         client: Ref<Client> = useClient()

     

       137
       135
        
       ): UseMutationResponse<T, V> {

     

       138
       136
        
         const data: Ref<T | undefined> = ref();

     

       139
       139
       -
         const stale: Ref<boolean> = ref(false);

     

       140
       140
       -
         const fetching: Ref<boolean> = ref(false);

     

       141
       141
       -
         const error: Ref<CombinedError | undefined> = shallowRef();

     

       142
       142
       -
         const operation: Ref<Operation<T, V> | undefined> = shallowRef();

     

       143
       143
       -
         const extensions: Ref<Record<string, any> | undefined> = shallowRef();

     

       137
       137
       +
       

     

       138
       138
       +
         const { fetching, operation, extensions, stale, error } = useRequestState<

     

       139
       139
       +
           T,

     

       140
       140
       +
           V

     

       141
       141
       +
         >();

     

       144
       142
        
       

     

       145
       143
        
         return {

     

       146
       144
        
           data,

     
···

       157
       155
        
       

     

       158
       156
        
             return pipe(

     

       159
       157
        
               client.value.executeMutation<T, V>(

     

       160
       160
       -
                 createRequest<T, V>(unref(query), unref(variables)),

     

       158
       158
       +
                 createRequestWithArgs({ query, variables }),

     

       161
       159
        
                 context || {}

     

       162
       160
        
               ),

     

       163
       161
        
               onPush(result => {

+322 -44

packages/vue-urql/src/useQuery.test.ts

···

       1
       1
       -
       import { OperationResult, OperationResultSource } from '@urql/core';

     

       2
       2
       -
       import { nextTick, reactive, ref } from 'vue';

     

       1
       1
       +
       import {

     

       2
       2
       +
         OperationResult,

     

       3
       3
       +
         OperationResultSource,

     

       4
       4
       +
         RequestPolicy,

     

       5
       5
       +
       } from '@urql/core';

     

       6
       6
       +
       import { computed, nextTick, reactive, readonly, ref } from 'vue';

     

       3
       7
        
       import { vi, expect, it, describe } from 'vitest';

     

       4
       8
        
       

     

       5
       9
        
       vi.mock('./useClient.ts', async () => ({

     
···

       10
       14
        
       

     

       11
       15
        
       import { pipe, makeSubject, fromValue, delay } from 'wonka';

     

       12
       16
        
       import { createClient } from '@urql/core';

     

       13
       13
       -
       import { useQuery } from './useQuery';

     

       17
       17
       +
       import { useQuery, UseQueryArgs } from './useQuery';

     

       14
       18
        
       

     

       15
       19
        
       const client = createClient({ url: '/graphql', exchanges: [] });

     

       16
       20
        
       

     

       21
       21
       +
       const createQuery = (args: UseQueryArgs) => {

     

       22
       22
       +
         const executeQuery = vi

     

       23
       23
       +
           .spyOn(client, 'executeQuery')

     

       24
       24
       +
           .mockImplementation(request => {

     

       25
       25
       +
             return pipe(

     

       26
       26
       +
               fromValue({ operation: request, data: { test: true } }),

     

       27
       27
       +
               delay(1)

     

       28
       28
       +
             ) as any;

     

       29
       29
       +
           });

     

       30
       30
       +
       

     

       31
       31
       +
         const query$ = useQuery(args);

     

       32
       32
       +
       

     

       33
       33
       +
         return {

     

       34
       34
       +
           query$,

     

       35
       35
       +
           executeQuery,

     

       36
       36
       +
         };

     

       37
       37
       +
       };

     

       38
       38
       +
       

     

       17
       39
        
       describe('useQuery', () => {

     

       18
       40
        
         it('runs a query and updates data', async () => {

     

       19
       41
        
           const subject = makeSubject<any>();

     
···

       23
       45
        
               () => subject.source as OperationResultSource<OperationResult>

     

       24
       46
        
             );

     

       25
       47
        
       

     

       26
       26
       -
           const _query = useQuery({

     

       48
       48
       +
           const query = useQuery({

     

       27
       49
        
             query: `{ test }`,

     

       28
       50
        
           });

     

       29
       29
       -
           const query = reactive(_query);

     

       30
       51
        
       

     

       31
       31
       -
           expect(query).toMatchObject({

     

       52
       52
       +
           expect(readonly(query)).toMatchObject({

     

       32
       53
        
             data: undefined,

     

       33
       54
        
             stale: false,

     

       34
       55
        
             fetching: true,

     
···

       54
       75
        
             }

     

       55
       76
        
           );

     

       56
       77
        
       

     

       57
       57
       -
           expect(query.fetching).toBe(true);

     

       78
       78
       +
           expect(query.fetching.value).toBe(true);

     

       58
       79
        
       

     

       59
       80
        
           subject.next({ data: { test: true } });

     

       60
       81
        
       

     

       61
       61
       -
           expect(query.fetching).toBe(false);

     

       62
       62
       -
           expect(query.data).toEqual({ test: true });

     

       82
       82
       +
           expect(query.fetching.value).toBe(false);

     

       83
       83
       +
           expect(query.data.value).toHaveProperty('test', true);

     

       63
       84
        
         });

     

       64
       85
        
       

     

       65
       86
        
         it('runs queries as a promise-like that resolves when used', async () => {

     
···

       79
       100
        
         });

     

       80
       101
        
       

     

       81
       102
        
         it('runs queries as a promise-like that resolves even when the query changes', async () => {

     

       82
       82
       -
           const executeQuery = vi

     

       83
       83
       -
             .spyOn(client, 'executeQuery')

     

       84
       84
       -
             .mockImplementation(request => {

     

       85
       85
       -
               return pipe(

     

       86
       86
       -
                 fromValue({ operation: request, data: { test: true } }),

     

       87
       87
       -
                 delay(1)

     

       88
       88
       -
               ) as any;

     

       89
       89
       -
             });

     

       90
       90
       -
       

     

       91
       103
        
           const doc = ref('{ test }');

     

       92
       104
        
       

     

       93
       93
       -
           const query$ = useQuery({

     

       105
       105
       +
           const { executeQuery, query$ } = createQuery({

     

       94
       106
        
             query: doc,

     

       95
       107
        
           });

     

       96
       108
        
       

     
···

       108
       120
        
           );

     

       109
       121
        
         });

     

       110
       122
        
       

     

       111
       111
       -
         it('reacts to variables changing', async () => {

     

       112
       112
       -
           const executeQuery = vi

     

       113
       113
       -
             .spyOn(client, 'executeQuery')

     

       114
       114
       -
             .mockImplementation(request => {

     

       115
       115
       -
               return pipe(

     

       116
       116
       -
                 fromValue({ operation: request, data: { test: true } }),

     

       117
       117
       -
                 delay(1)

     

       118
       118
       -
               ) as any;

     

       119
       119
       -
             });

     

       123
       123
       +
         it('runs a query with different variables', async () => {

     

       124
       124
       +
           const simpleVariables = {

     

       125
       125
       +
             null: null,

     

       126
       126
       +
             NaN: NaN,

     

       127
       127
       +
             empty: '',

     

       128
       128
       +
             bool: false,

     

       129
       129
       +
             int: 1,

     

       130
       130
       +
             float: 1.1,

     

       131
       131
       +
             string: 'string',

     

       132
       132
       +
             blob: new Blob(),

     

       133
       133
       +
             date: new Date(),

     

       134
       134
       +
           };

     

       120
       135
        
       

     

       121
       121
       -
           const variables = {

     

       122
       122
       -
             test: ref(1),

     

       136
       136
       +
           const variablesSet = {

     

       137
       137
       +
             func: () => 'func',

     

       138
       138
       +
             ref: ref('ref'),

     

       139
       139
       +
             computed: computed(() => 'computed'),

     

       140
       140
       +
             ...simpleVariables,

     

       141
       141
       +
           };

     

       142
       142
       +
       

     

       143
       143
       +
           const variablesSetUnwrapped = {

     

       144
       144
       +
             func: 'func',

     

       145
       145
       +
             ref: 'ref',

     

       146
       146
       +
             computed: 'computed',

     

       147
       147
       +
             ...simpleVariables,

     

       123
       148
        
           };

     

       124
       124
       -
           const query$ = useQuery({

     

       125
       125
       -
             query: '{ test }',

     

       149
       149
       +
       

     

       150
       150
       +
           const { query$ } = createQuery({

     

       151
       151
       +
             query: ref('{ test }'),

     

       152
       152
       +
             variables: {

     

       153
       153
       +
               ...variablesSet,

     

       154
       154
       +
               nested: variablesSet,

     

       155
       155
       +
               array: [variablesSet],

     

       156
       156
       +
             },

     

       157
       157
       +
           });

     

       158
       158
       +
       

     

       159
       159
       +
           await query$;

     

       160
       160
       +
       

     

       161
       161
       +
           expect(query$.operation.value?.variables).toStrictEqual({

     

       162
       162
       +
             ...variablesSetUnwrapped,

     

       163
       163
       +
             nested: variablesSetUnwrapped,

     

       164
       164
       +
             array: [variablesSetUnwrapped],

     

       165
       165
       +
           });

     

       166
       166
       +
         });

     

       167
       167
       +
       

     

       168
       168
       +
         it('reacts to ref variables changing', async () => {

     

       169
       169
       +
           const variables = ref({ prop: 1 });

     

       170
       170
       +
       

     

       171
       171
       +
           const { executeQuery, query$ } = createQuery({

     

       172
       172
       +
             query: ref('{ test }'),

     

       126
       173
        
             variables,

     

       127
       174
        
           });

     

       128
       175
        
       

     

       129
       176
        
           await query$;

     

       177
       177
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       178
       178
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 1);

     

       130
       179
        
       

     

       180
       180
       +
           variables.value.prop++;

     

       181
       181
       +
           await query$;

     

       182
       182
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       183
       183
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 2);

     

       184
       184
       +
       

     

       185
       185
       +
           variables.value = { prop: 3 };

     

       186
       186
       +
           await query$;

     

       187
       187
       +
           expect(executeQuery).toHaveBeenCalledTimes(3);

     

       188
       188
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 3);

     

       189
       189
       +
         });

     

       190
       190
       +
       

     

       191
       191
       +
         it('reacts to nested ref variables changing', async () => {

     

       192
       192
       +
           const prop = ref(1);

     

       193
       193
       +
       

     

       194
       194
       +
           const { executeQuery, query$ } = createQuery({

     

       195
       195
       +
             query: ref('{ test }'),

     

       196
       196
       +
             variables: { prop },

     

       197
       197
       +
           });

     

       198
       198
       +
       

     

       199
       199
       +
           await query$;

     

       131
       200
        
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       201
       201
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 1);

     

       132
       202
        
       

     

       133
       133
       -
           expect(query$.operation.value).toHaveProperty('variables.test', 1);

     

       203
       203
       +
           prop.value++;

     

       204
       204
       +
           await query$;

     

       205
       205
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       206
       206
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 2);

     

       207
       207
       +
         });

     

       134
       208
        
       

     

       135
       135
       -
           variables.test.value = 2;

     

       209
       209
       +
         it('reacts to deep nested ref variables changing', async () => {

     

       210
       210
       +
           const prop = ref(1);

     

       211
       211
       +
       

     

       212
       212
       +
           const { executeQuery, query$ } = createQuery({

     

       213
       213
       +
             query: ref('{ test }'),

     

       214
       214
       +
             variables: { deep: { nested: { prop } } },

     

       215
       215
       +
           });

     

       136
       216
        
       

     

       137
       217
        
           await query$;

     

       218
       218
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       219
       219
       +
           expect(query$.operation.value).toHaveProperty(

     

       220
       220
       +
             'variables.deep.nested.prop',

     

       221
       221
       +
             1

     

       222
       222
       +
           );

     

       138
       223
        
       

     

       224
       224
       +
           prop.value++;

     

       225
       225
       +
           await query$;

     

       139
       226
        
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       140
       140
       -
           expect(query$.operation.value).toHaveProperty('variables.test', 2);

     

       227
       227
       +
           expect(query$.operation.value).toHaveProperty(

     

       228
       228
       +
             'variables.deep.nested.prop',

     

       229
       229
       +
             2

     

       230
       230
       +
           );

     

       231
       231
       +
         });

     

       232
       232
       +
       

     

       233
       233
       +
         it('reacts to reactive variables changing', async () => {

     

       234
       234
       +
           const prop = ref(1);

     

       235
       235
       +
           const variables = reactive({ prop: 1, deep: { nested: { prop } } });

     

       236
       236
       +
       

     

       237
       237
       +
           const { executeQuery, query$ } = createQuery({

     

       238
       238
       +
             query: ref('{ test }'),

     

       239
       239
       +
             variables,

     

       240
       240
       +
           });

     

       241
       241
       +
       

     

       242
       242
       +
           await query$;

     

       243
       243
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       244
       244
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 1);

     

       245
       245
       +
       

     

       246
       246
       +
           variables.prop++;

     

       247
       247
       +
           await query$;

     

       248
       248
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       249
       249
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 2);

     

       250
       250
       +
       

     

       251
       251
       +
           prop.value++;

     

       252
       252
       +
           await query$;

     

       253
       253
       +
           expect(executeQuery).toHaveBeenCalledTimes(3);

     

       254
       254
       +
           expect(query$.operation.value).toHaveProperty(

     

       255
       255
       +
             'variables.deep.nested.prop',

     

       256
       256
       +
             2

     

       257
       257
       +
           );

     

       258
       258
       +
         });

     

       259
       259
       +
       

     

       260
       260
       +
         it('reacts to computed variables changing', async () => {

     

       261
       261
       +
           const prop = ref(1);

     

       262
       262
       +
           const prop2 = ref(1);

     

       263
       263
       +
           const variables = computed(() => ({

     

       264
       264
       +
             prop: prop.value,

     

       265
       265
       +
             deep: { nested: { prop2 } },

     

       266
       266
       +
           }));

     

       267
       267
       +
       

     

       268
       268
       +
           const { executeQuery, query$ } = createQuery({

     

       269
       269
       +
             query: ref('{ test }'),

     

       270
       270
       +
             variables,

     

       271
       271
       +
           });

     

       272
       272
       +
       

     

       273
       273
       +
           await query$;

     

       274
       274
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       275
       275
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 1);

     

       276
       276
       +
       

     

       277
       277
       +
           prop.value++;

     

       278
       278
       +
           await query$;

     

       279
       279
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       280
       280
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 2);

     

       281
       281
       +
       

     

       282
       282
       +
           prop2.value++;

     

       283
       283
       +
           await query$;

     

       284
       284
       +
           expect(executeQuery).toHaveBeenCalledTimes(3);

     

       285
       285
       +
           expect(query$.operation.value).toHaveProperty(

     

       286
       286
       +
             'variables.deep.nested.prop2',

     

       287
       287
       +
             2

     

       288
       288
       +
           );

     

       289
       289
       +
         });

     

       290
       290
       +
       

     

       291
       291
       +
         it('reacts to callback variables changing', async () => {

     

       292
       292
       +
           const prop = ref(1);

     

       293
       293
       +
           const prop2 = ref(1);

     

       294
       294
       +
           const variables = () => ({

     

       295
       295
       +
             prop: prop.value,

     

       296
       296
       +
             deep: { nested: { prop2 } },

     

       297
       297
       +
           });

     

       298
       298
       +
       

     

       299
       299
       +
           const { executeQuery, query$ } = createQuery({

     

       300
       300
       +
             query: ref('{ test }'),

     

       301
       301
       +
             variables,

     

       302
       302
       +
           });

     

       303
       303
       +
       

     

       304
       304
       +
           await query$;

     

       305
       305
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       306
       306
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 1);

     

       307
       307
       +
       

     

       308
       308
       +
           prop.value++;

     

       309
       309
       +
           await query$;

     

       310
       310
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       311
       311
       +
           expect(query$.operation.value).toHaveProperty('variables.prop', 2);

     

       312
       312
       +
       

     

       313
       313
       +
           prop2.value++;

     

       314
       314
       +
           await query$;

     

       315
       315
       +
           expect(executeQuery).toHaveBeenCalledTimes(3);

     

       316
       316
       +
           expect(query$.operation.value).toHaveProperty(

     

       317
       317
       +
             'variables.deep.nested.prop2',

     

       318
       318
       +
             2

     

       319
       319
       +
           );

     

       320
       320
       +
         });

     

       321
       321
       +
       

     

       322
       322
       +
         it('reacts to reactive context argument', async () => {

     

       323
       323
       +
           const context = ref<{ requestPolicy: RequestPolicy }>({

     

       324
       324
       +
             requestPolicy: 'cache-only',

     

       325
       325
       +
           });

     

       326
       326
       +
       

     

       327
       327
       +
           const { executeQuery, query$ } = createQuery({

     

       328
       328
       +
             query: ref('{ test }'),

     

       329
       329
       +
             context,

     

       330
       330
       +
           });

     

       331
       331
       +
       

     

       332
       332
       +
           await query$;

     

       333
       333
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       334
       334
       +
       

     

       335
       335
       +
           context.value.requestPolicy = 'network-only';

     

       336
       336
       +
           await query$;

     

       337
       337
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       338
       338
       +
         });

     

       339
       339
       +
       

     

       340
       340
       +
         it('reacts to callback context argument', async () => {

     

       341
       341
       +
           const requestPolicy = ref<RequestPolicy>('cache-only');

     

       342
       342
       +
       

     

       343
       343
       +
           const { executeQuery, query$ } = createQuery({

     

       344
       344
       +
             query: ref('{ test }'),

     

       345
       345
       +
             context: () => ({

     

       346
       346
       +
               requestPolicy: requestPolicy.value,

     

       347
       347
       +
             }),

     

       348
       348
       +
           });

     

       349
       349
       +
       

     

       350
       350
       +
           await query$;

     

       351
       351
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       352
       352
       +
       

     

       353
       353
       +
           requestPolicy.value = 'network-only';

     

       354
       354
       +
           await query$;

     

       355
       355
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       141
       356
        
         });

     

       142
       357
        
       

     

       143
       358
        
         it('pauses query when asked to do so', async () => {

     
···

       148
       363
        
               () => subject.source as OperationResultSource<OperationResult>

     

       149
       364
        
             );

     

       150
       365
        
       

     

       366
       366
       +
           const query = useQuery({

     

       367
       367
       +
             query: `{ test }`,

     

       368
       368
       +
             pause: true,

     

       369
       369
       +
           });

     

       370
       370
       +
       

     

       371
       371
       +
           expect(executeQuery).not.toHaveBeenCalled();

     

       372
       372
       +
       

     

       373
       373
       +
           query.resume();

     

       374
       374
       +
           await nextTick();

     

       375
       375
       +
           expect(query.fetching.value).toBe(true);

     

       376
       376
       +
       

     

       377
       377
       +
           subject.next({ data: { test: true } });

     

       378
       378
       +
       

     

       379
       379
       +
           expect(query.fetching.value).toBe(false);

     

       380
       380
       +
           expect(query.data.value).toHaveProperty('test', true);

     

       381
       381
       +
         });

     

       382
       382
       +
       

     

       383
       383
       +
         it('pauses query with ref variable', async () => {

     

       151
       384
        
           const pause = ref(true);

     

       152
       385
        
       

     

       153
       153
       -
           const _query = useQuery({

     

       154
       154
       -
             query: `{ test }`,

     

       386
       386
       +
           const { executeQuery, query$ } = createQuery({

     

       387
       387
       +
             query: ref('{ test }'),

     

       388
       388
       +
             pause,

     

       389
       389
       +
           });

     

       390
       390
       +
       

     

       391
       391
       +
           await query$;

     

       392
       392
       +
           expect(executeQuery).not.toHaveBeenCalled();

     

       393
       393
       +
       

     

       394
       394
       +
           pause.value = false;

     

       395
       395
       +
           await query$;

     

       396
       396
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       397
       397
       +
       

     

       398
       398
       +
           query$.pause();

     

       399
       399
       +
           query$.resume();

     

       400
       400
       +
           await query$;

     

       401
       401
       +
           expect(executeQuery).toHaveBeenCalledTimes(2);

     

       402
       402
       +
         });

     

       403
       403
       +
       

     

       404
       404
       +
         it('pauses query with computed variable', async () => {

     

       405
       405
       +
           const pause = ref(true);

     

       406
       406
       +
       

     

       407
       407
       +
           const { executeQuery, query$ } = createQuery({

     

       408
       408
       +
             query: ref('{ test }'),

     

       409
       409
       +
             pause: computed(() => pause.value),

     

       410
       410
       +
           });

     

       411
       411
       +
       

     

       412
       412
       +
           await query$;

     

       413
       413
       +
           expect(executeQuery).not.toHaveBeenCalled();

     

       414
       414
       +
       

     

       415
       415
       +
           pause.value = false;

     

       416
       416
       +
           await query$;

     

       417
       417
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       418
       418
       +
       

     

       419
       419
       +
           query$.pause();

     

       420
       420
       +
           query$.resume();

     

       421
       421
       +
           await query$;

     

       422
       422
       +
           // this shouldn't be called, as pause/resume functionality should works in sync with passed `pause` variable, e.g.:

     

       423
       423
       +
           // if we pass readonly computed variable, then we want to make sure that its value fully controls the state of the request.

     

       424
       424
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       425
       425
       +
         });

     

       426
       426
       +
       

     

       427
       427
       +
         it('pauses query with callback', async () => {

     

       428
       428
       +
           const pause = ref(true);

     

       429
       429
       +
       

     

       430
       430
       +
           const { executeQuery, query$ } = createQuery({

     

       431
       431
       +
             query: ref('{ test }'),

     

       155
       432
        
             pause: () => pause.value,

     

       156
       433
        
           });

     

       157
       157
       -
           const query = reactive(_query);

     

       158
       434
        
       

     

       435
       435
       +
           await query$;

     

       159
       436
        
           expect(executeQuery).not.toHaveBeenCalled();

     

       160
       437
        
       

     

       161
       438
        
           pause.value = false;

     

       162
       162
       -
           await nextTick();

     

       163
       163
       -
           expect(query.fetching).toBe(true);

     

       439
       439
       +
           await query$;

     

       440
       440
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       164
       441
        
       

     

       165
       165
       -
           subject.next({ data: { test: true } });

     

       166
       166
       -
       

     

       167
       167
       -
           expect(query.fetching).toBe(false);

     

       168
       168
       -
           expect(query.data).toEqual({ test: true });

     

       442
       442
       +
           query$.pause();

     

       443
       443
       +
           query$.resume();

     

       444
       444
       +
           await query$;

     

       445
       445
       +
           // the same as computed variable example - user has full control over the request state if using callback

     

       446
       446
       +
           expect(executeQuery).toHaveBeenCalledTimes(1);

     

       169
       447
        
         });

     

       170
       448
        
       });

+76 -146

packages/vue-urql/src/useQuery.ts

···

       1
       1
        
       /* eslint-disable react-hooks/rules-of-hooks */

     

       2
       2
        
       

     

       3
       3
        
       import type { Ref, WatchStopHandle } from 'vue';

     

       4
       4
       -
       import { isRef, ref, shallowRef, watch, watchEffect, reactive } from 'vue';

     

       4
       4
       +
       import { ref, watchEffect } from 'vue';

     

       5
       5
        
       

     

       6
       6
       -
       import type { Subscription, Source } from 'wonka';

     

       6
       6
       +
       import type { Subscription } from 'wonka';

     

       7
       7
        
       import { pipe, subscribe, onEnd } from 'wonka';

     

       8
       8
        
       

     

       9
       9
        
       import type {

     

       10
       10
        
         Client,

     

       11
       11
        
         AnyVariables,

     

       12
       12
       -
         OperationResult,

     

       13
       12
        
         GraphQLRequestParams,

     

       14
       13
        
         CombinedError,

     

       15
       14
        
         OperationContext,

     

       16
       15
        
         RequestPolicy,

     

       17
       16
        
         Operation,

     

       18
       17
        
       } from '@urql/core';

     

       19
       19
       -
       import { createRequest } from '@urql/core';

     

       20
       18
        
       

     

       21
       19
        
       import { useClient } from './useClient';

     

       22
       20
        
       

     

       23
       21
        
       import type { MaybeRef, MaybeRefObj } from './utils';

     

       24
       24
       -
       import { unref, updateShallowRef } from './utils';

     

       22
       22
       +
       import { useRequestState, useClientState } from './utils';

     

       25
       23
        
       

     

       26
       24
        
       /** Input arguments for the {@link useQuery} function.

     

       27
       25
        
        *

     
···

       195
       193
        
         V extends AnyVariables = AnyVariables,

     

       196
       194
        
       > = UseQueryState<T, V> & PromiseLike<UseQueryState<T, V>>;

     

       197
       195
        
       

     

       198
       198
       -
       const watchOptions = {

     

       199
       199
       -
         flush: 'pre' as const,

     

       200
       200
       -
       };

     

       201
       201
       -
       

     

       202
       196
        
       /** Function to run a GraphQL query and get reactive GraphQL results.

     

       203
       197
        
        *

     

       204
       198
        
        * @param args - a {@link UseQueryArgs} object, to pass a `query`, `variables`, and options.

     
···

       241
       235
        
       }

     

       242
       236
        
       

     

       243
       237
        
       export function callUseQuery<T = any, V extends AnyVariables = AnyVariables>(

     

       244
       244
       -
         _args: UseQueryArgs<T, V>,

     

       238
       238
       +
         args: UseQueryArgs<T, V>,

     

       245
       239
        
         client: Ref<Client> = useClient(),

     

       246
       246
       -
         stops: WatchStopHandle[] = []

     

       240
       240
       +
         stops?: WatchStopHandle[]

     

       247
       241
        
       ): UseQueryResponse<T, V> {

     

       248
       248
       -
         const args = reactive(_args) as UseQueryArgs<T, V>;

     

       249
       249
       -
       

     

       250
       242
        
         const data: Ref<T | undefined> = ref();

     

       251
       251
       -
         const stale: Ref<boolean> = ref(false);

     

       252
       252
       -
         const fetching: Ref<boolean> = ref(false);

     

       253
       253
       -
         const error: Ref<CombinedError | undefined> = shallowRef();

     

       254
       254
       -
         const operation: Ref<Operation<T, V> | undefined> = shallowRef();

     

       255
       255
       -
         const extensions: Ref<Record<string, any> | undefined> = shallowRef();

     

       256
       243
        
       

     

       257
       257
       -
         const isPaused: Ref<boolean> = ref(!!unref(args.pause));

     

       258
       258
       -
         if (isRef(args.pause) || typeof args.pause === 'function') {

     

       259
       259
       -
           stops.push(watch(args.pause, value => (isPaused.value = value)));

     

       260
       260
       -
         }

     

       244
       244
       +
         const { fetching, operation, extensions, stale, error } = useRequestState<

     

       245
       245
       +
           T,

     

       246
       246
       +
           V

     

       247
       247
       +
         >();

     

       261
       248
        
       

     

       262
       262
       -
         const input = shallowRef({

     

       263
       263
       -
           request: createRequest<T, V>(unref(args.query), unref(args.variables) as V),

     

       264
       264
       -
           requestPolicy: unref(args.requestPolicy),

     

       265
       265
       -
           isPaused: isPaused.value,

     

       266
       266
       -
         });

     

       249
       249
       +
         const { isPaused, source, pause, resume, execute, teardown } = useClientState(

     

       250
       250
       +
           args,

     

       251
       251
       +
           client,

     

       252
       252
       +
           'executeQuery'

     

       253
       253
       +
         );

     

       267
       254
        
       

     

       268
       268
       -
         const source: Ref<Source<OperationResult<T, V>> | undefined> = ref();

     

       255
       255
       +
         const teardownQuery = watchEffect(

     

       256
       256
       +
           onInvalidate => {

     

       257
       257
       +
             if (source.value) {

     

       258
       258
       +
               fetching.value = true;

     

       259
       259
       +
               stale.value = false;

     

       269
       260
        
       

     

       270
       270
       -
         stops.push(

     

       271
       271
       -
           watchEffect(() => {

     

       272
       272
       -
             updateShallowRef(input, {

     

       273
       273
       -
               request: createRequest<T, V>(

     

       274
       274
       -
                 unref(args.query),

     

       275
       275
       -
                 unref(args.variables) as V

     

       276
       276
       -
               ),

     

       277
       277
       -
               requestPolicy: unref(args.requestPolicy),

     

       278
       278
       -
               isPaused: isPaused.value,

     

       279
       279
       -
             });

     

       280
       280
       -
           }, watchOptions)

     

       261
       261
       +
               onInvalidate(

     

       262
       262
       +
                 pipe(

     

       263
       263
       +
                   source.value,

     

       264
       264
       +
                   onEnd(() => {

     

       265
       265
       +
                     fetching.value = false;

     

       266
       266
       +
                     stale.value = false;

     

       267
       267
       +
                   }),

     

       268
       268
       +
                   subscribe(res => {

     

       269
       269
       +
                     data.value = res.data;

     

       270
       270
       +
                     stale.value = !!res.stale;

     

       271
       271
       +
                     fetching.value = false;

     

       272
       272
       +
                     error.value = res.error;

     

       273
       273
       +
                     operation.value = res.operation;

     

       274
       274
       +
                     extensions.value = res.extensions;

     

       275
       275
       +
                   })

     

       276
       276
       +
                 ).unsubscribe

     

       277
       277
       +
               );

     

       278
       278
       +
             } else {

     

       279
       279
       +
               fetching.value = false;

     

       280
       280
       +
               stale.value = false;

     

       281
       281
       +
             }

     

       282
       282
       +
           },

     

       283
       283
       +
           {

     

       284
       284
       +
             // NOTE: This part of the query pipeline is only initialised once and will need

     

       285
       285
       +
             // to do so synchronously

     

       286
       286
       +
             flush: 'sync',

     

       287
       287
       +
           }

     

       281
       288
        
         );

     

       282
       289
        
       

     

       283
       283
       -
         stops.push(

     

       284
       284
       -
           watchEffect(() => {

     

       285
       285
       -
             source.value = !input.value.isPaused

     

       286
       286
       -
               ? client.value.executeQuery<T, V>(input.value.request, {

     

       287
       287
       -
                   requestPolicy: unref(args.requestPolicy),

     

       288
       288
       -
                   ...unref(args.context),

     

       289
       289
       -
                 })

     

       290
       290
       -
               : undefined;

     

       291
       291
       -
           }, watchOptions)

     

       292
       292
       -
         );

     

       290
       290
       +
         stops && stops.push(teardown, teardownQuery);

     

       291
       291
       +
       

     

       292
       292
       +
         const then: UseQueryResponse<T, V>['then'] = (onFulfilled, onRejected) => {

     

       293
       293
       +
           let sub: Subscription | void;

     

       294
       294
       +
       

     

       295
       295
       +
           const promise = new Promise<UseQueryState<T, V>>(resolve => {

     

       296
       296
       +
             if (!source.value) {

     

       297
       297
       +
               return resolve(state);

     

       298
       298
       +
             }

     

       299
       299
       +
             let hasResult = false;

     

       300
       300
       +
             sub = pipe(

     

       301
       301
       +
               source.value,

     

       302
       302
       +
               subscribe(() => {

     

       303
       303
       +
                 if (!state.fetching.value && !state.stale.value) {

     

       304
       304
       +
                   if (sub) sub.unsubscribe();

     

       305
       305
       +
                   hasResult = true;

     

       306
       306
       +
                   resolve(state);

     

       307
       307
       +
                 }

     

       308
       308
       +
               })

     

       309
       309
       +
             );

     

       310
       310
       +
             if (hasResult) sub.unsubscribe();

     

       311
       311
       +
           });

     

       312
       312
       +
       

     

       313
       313
       +
           return promise.then(onFulfilled, onRejected);

     

       314
       314
       +
         };

     

       293
       315
        
       

     

       294
       316
        
         const state: UseQueryState<T, V> = {

     

       295
       317
        
           data,

     
···

       299
       321
        
           extensions,

     

       300
       322
        
           fetching,

     

       301
       323
        
           isPaused,

     

       324
       324
       +
           pause,

     

       325
       325
       +
           resume,

     

       302
       326
        
           executeQuery(opts?: Partial<OperationContext>): UseQueryResponse<T, V> {

     

       303
       303
       -
             const s = (source.value = client.value.executeQuery<T, V>(

     

       304
       304
       -
               input.value.request,

     

       305
       305
       -
               {

     

       306
       306
       -
                 requestPolicy: unref(args.requestPolicy),

     

       307
       307
       -
                 ...unref(args.context),

     

       308
       308
       -
                 ...opts,

     

       309
       309
       -
               }

     

       310
       310
       -
             ));

     

       311
       311
       -
       

     

       312
       312
       -
             return {

     

       313
       313
       -
               ...response,

     

       314
       314
       -
               then(onFulfilled, onRejected) {

     

       315
       315
       -
                 let sub: Subscription | void;

     

       316
       316
       -
                 return new Promise<UseQueryState<T, V>>(resolve => {

     

       317
       317
       -
                   let hasResult = false;

     

       318
       318
       -
                   sub = pipe(

     

       319
       319
       -
                     s,

     

       320
       320
       -
                     subscribe(() => {

     

       321
       321
       -
                       if (!state.fetching.value && !state.stale.value) {

     

       322
       322
       -
                         if (sub) sub.unsubscribe();

     

       323
       323
       -
                         hasResult = true;

     

       324
       324
       -
                         resolve(state);

     

       325
       325
       -
                       }

     

       326
       326
       -
                     })

     

       327
       327
       -
                   );

     

       328
       328
       -
                   if (hasResult) sub.unsubscribe();

     

       329
       329
       -
                 }).then(onFulfilled, onRejected);

     

       330
       330
       -
               },

     

       331
       331
       -
             };

     

       332
       332
       -
           },

     

       333
       333
       -
           pause() {

     

       334
       334
       -
             isPaused.value = true;

     

       335
       335
       -
           },

     

       336
       336
       -
           resume() {

     

       337
       337
       -
             isPaused.value = false;

     

       327
       327
       +
             execute(opts);

     

       328
       328
       +
             return { ...state, then };

     

       338
       329
        
           },

     

       339
       330
        
         };

     

       340
       331
        
       

     

       341
       341
       -
         stops.push(

     

       342
       342
       -
           watchEffect(

     

       343
       343
       -
             onInvalidate => {

     

       344
       344
       -
               if (source.value) {

     

       345
       345
       -
                 fetching.value = true;

     

       346
       346
       -
                 stale.value = false;

     

       347
       347
       -
       

     

       348
       348
       -
                 onInvalidate(

     

       349
       349
       -
                   pipe(

     

       350
       350
       -
                     source.value,

     

       351
       351
       -
                     onEnd(() => {

     

       352
       352
       -
                       fetching.value = false;

     

       353
       353
       -
                       stale.value = false;

     

       354
       354
       -
                     }),

     

       355
       355
       -
                     subscribe(res => {

     

       356
       356
       -
                       data.value = res.data;

     

       357
       357
       -
                       stale.value = !!res.stale;

     

       358
       358
       -
                       fetching.value = false;

     

       359
       359
       -
                       error.value = res.error;

     

       360
       360
       -
                       operation.value = res.operation;

     

       361
       361
       -
                       extensions.value = res.extensions;

     

       362
       362
       -
                     })

     

       363
       363
       -
                   ).unsubscribe

     

       364
       364
       -
                 );

     

       365
       365
       -
               } else {

     

       366
       366
       -
                 fetching.value = false;

     

       367
       367
       -
                 stale.value = false;

     

       368
       368
       -
               }

     

       369
       369
       -
             },

     

       370
       370
       -
             {

     

       371
       371
       -
               // NOTE: This part of the query pipeline is only initialised once and will need

     

       372
       372
       -
               // to do so synchronously

     

       373
       373
       -
               flush: 'sync',

     

       374
       374
       -
             }

     

       375
       375
       -
           )

     

       376
       376
       -
         );

     

       377
       377
       -
       

     

       378
       378
       -
         const response: UseQueryResponse<T, V> = {

     

       379
       379
       -
           ...state,

     

       380
       380
       -
           then(onFulfilled, onRejected) {

     

       381
       381
       -
             let sub: Subscription | void;

     

       382
       382
       -
             const promise = new Promise<UseQueryState<T, V>>(resolve => {

     

       383
       383
       -
               if (!source.value) return resolve(state);

     

       384
       384
       -
               let hasResult = false;

     

       385
       385
       -
               sub = pipe(

     

       386
       386
       -
                 source.value,

     

       387
       387
       -
                 subscribe(() => {

     

       388
       388
       -
                   if (!state.fetching.value && !state.stale.value) {

     

       389
       389
       -
                     if (sub) sub.unsubscribe();

     

       390
       390
       -
                     hasResult = true;

     

       391
       391
       -
                     resolve(state);

     

       392
       392
       -
                   }

     

       393
       393
       -
                 })

     

       394
       394
       -
               );

     

       395
       395
       -
               if (hasResult) sub.unsubscribe();

     

       396
       396
       -
             });

     

       397
       397
       -
       

     

       398
       398
       -
             return promise.then(onFulfilled, onRejected);

     

       399
       399
       -
           },

     

       400
       400
       -
         };

     

       401
       401
       -
       

     

       402
       402
       -
         return response;

     

       332
       332
       +
         return { ...state, then };

     

       403
       333
        
       }

+25 -28

packages/vue-urql/src/useSubscription.test.ts

···

       1
       1
        
       // @vitest-environment jsdom

     

       2
       2
        
       

     

       3
       3
        
       import { OperationResult, OperationResultSource } from '@urql/core';

     

       4
       4
       -
       import { nextTick, reactive, ref } from 'vue';

     

       4
       4
       +
       import { nextTick, readonly, ref } from 'vue';

     

       5
       5
        
       import { vi, expect, it, describe } from 'vitest';

     

       6
       6
        
       

     

       7
       7
        
       vi.mock('./useClient.ts', async () => ({

     
···

       25
       25
        
               () => subject.source as OperationResultSource<OperationResult>

     

       26
       26
        
             );

     

       27
       27
        
       

     

       28
       28
       -
           const sub = reactive(

     

       29
       29
       -
             useSubscription({

     

       30
       30
       -
               query: `{ test }`,

     

       31
       31
       -
             })

     

       32
       32
       -
           );

     

       28
       28
       +
           const sub = useSubscription({

     

       29
       29
       +
             query: `{ test }`,

     

       30
       30
       +
           });

     

       33
       31
        
       

     

       34
       34
       -
           expect(sub).toMatchObject({

     

       32
       32
       +
           expect(readonly(sub)).toMatchObject({

     

       35
       33
        
             data: undefined,

     

       36
       34
        
             stale: false,

     

       37
       35
        
             fetching: true,

     
···

       53
       51
        
             expect.any(Object)

     

       54
       52
        
           );

     

       55
       53
        
       

     

       56
       56
       -
           expect(sub.fetching).toBe(true);

     

       54
       54
       +
           expect(sub.fetching.value).toBe(true);

     

       57
       55
        
       

     

       58
       56
        
           subject.next({ data: { test: true } });

     

       59
       59
       -
           expect(sub.data).toEqual({ test: true });

     

       57
       57
       +
           expect(sub.data.value).toHaveProperty('test', true);

     

       58
       58
       +
       

     

       60
       59
        
           subject.complete();

     

       61
       61
       -
           expect(sub.fetching).toBe(false);

     

       60
       60
       +
           expect(sub.fetching.value).toBe(false);

     

       62
       61
        
         });

     

       63
       62
        
       

     

       64
       63
        
         it('updates the executed subscription when inputs change', async () => {

     
···

       70
       69
        
             );

     

       71
       70
        
       

     

       72
       71
        
           const variables = ref({});

     

       73
       73
       -
           const sub = reactive(

     

       74
       74
       -
             useSubscription({

     

       75
       75
       -
               query: `{ test }`,

     

       76
       76
       -
               variables,

     

       77
       77
       -
             })

     

       78
       78
       -
           );

     

       72
       72
       +
           const sub = useSubscription({

     

       73
       73
       +
             query: `{ test }`,

     

       74
       74
       +
             variables,

     

       75
       75
       +
           });

     

       79
       76
        
       

     

       80
       77
        
           expect(executeSubscription).toHaveBeenCalledWith(

     

       81
       78
        
             {

     
···

       87
       84
        
           );

     

       88
       85
        
       

     

       89
       86
        
           subject.next({ data: { test: true } });

     

       90
       90
       -
           expect(sub.data).toEqual({ test: true });

     

       87
       87
       +
           expect(sub.data.value).toHaveProperty('test', true);

     

       91
       88
        
       

     

       92
       89
        
           variables.value = { test: true };

     

       93
       90
        
           await nextTick();

     
···

       101
       98
        
             expect.any(Object)

     

       102
       99
        
           );

     

       103
       100
        
       

     

       104
       104
       -
           expect(sub.fetching).toBe(true);

     

       105
       105
       -
           expect(sub.data).toEqual({ test: true });

     

       101
       101
       +
           expect(sub.fetching.value).toBe(true);

     

       102
       102
       +
           expect(sub.data.value).toHaveProperty('test', true);

     

       106
       103
        
         });

     

       104
       104
       +
       

     

       107
       105
        
         it('supports a custom scanning handler', async () => {

     

       108
       106
        
           const subject = makeSubject<any>();

     

       109
       107
        
           const executeSubscription = vi

     
···

       115
       113
        
           const scanHandler = (currentState: any, nextState: any) => ({

     

       116
       114
        
             counter: (currentState ? currentState.counter : 0) + nextState.counter,

     

       117
       115
        
           });

     

       118
       118
       -
           const sub = reactive(

     

       119
       119
       -
             useSubscription(

     

       120
       120
       -
               {

     

       121
       121
       -
                 query: `subscription { counter }`,

     

       122
       122
       -
               },

     

       123
       123
       -
               scanHandler

     

       124
       124
       -
             )

     

       116
       116
       +
       

     

       117
       117
       +
           const sub = useSubscription(

     

       118
       118
       +
             {

     

       119
       119
       +
               query: `subscription { counter }`,

     

       120
       120
       +
             },

     

       121
       121
       +
             scanHandler

     

       125
       122
        
           );

     

       126
       123
        
       

     

       127
       124
        
           expect(executeSubscription).toHaveBeenCalledWith(

     
···

       134
       131
        
           );

     

       135
       132
        
       

     

       136
       133
        
           subject.next({ data: { counter: 1 } });

     

       137
       137
       -
           expect(sub.data).toEqual({ counter: 1 });

     

       134
       134
       +
           expect(sub.data.value).toHaveProperty('counter', 1);

     

       138
       135
        
       

     

       139
       136
        
           subject.next({ data: { counter: 2 } });

     

       140
       140
       -
           expect(sub.data).toEqual({ counter: 3 });

     

       137
       137
       +
           expect(sub.data.value).toHaveProperty('counter', 3);

     

       141
       138
        
         });

     

       142
       139
        
       });

+51 -95

packages/vue-urql/src/useSubscription.ts

···

       1
       1
        
       /* eslint-disable react-hooks/rules-of-hooks */

     

       2
       2
        
       

     

       3
       3
       -
       import type { Source } from 'wonka';

     

       4
       3
        
       import { pipe, subscribe, onEnd } from 'wonka';

     

       5
       4
        
       

     

       6
       5
        
       import type { Ref, WatchStopHandle } from 'vue';

     

       7
       7
       -
       import { isRef, ref, shallowRef, watch, watchEffect, reactive } from 'vue';

     

       6
       6
       +
       import { isRef, ref, watchEffect } from 'vue';

     

       8
       7
        
       

     

       9
       8
        
       import type {

     

       10
       9
        
         Client,

     

       11
       10
        
         GraphQLRequestParams,

     

       12
       11
        
         AnyVariables,

     

       13
       13
       -
         OperationResult,

     

       14
       12
        
         CombinedError,

     

       15
       13
        
         OperationContext,

     

       16
       14
        
         Operation,

     

       17
       15
        
       } from '@urql/core';

     

       18
       18
       -
       import { createRequest } from '@urql/core';

     

       19
       16
        
       

     

       20
       17
        
       import { useClient } from './useClient';

     

       21
       18
        
       

     

       22
       19
        
       import type { MaybeRef, MaybeRefObj } from './utils';

     

       23
       23
       -
       import { unref, updateShallowRef } from './utils';

     

       20
       20
       +
       import { useRequestState, useClientState } from './utils';

     

       24
       21
        
       

     

       25
       22
        
       /** Input arguments for the {@link useSubscription} function.

     

       26
       23
        
        *

     
···

       89
       86
        
       export type SubscriptionHandler<T, R> = (prev: R | undefined, data: T) => R;

     

       90
       87
        
       

     

       91
       88
        
       /** A {@link SubscriptionHandler} or a reactive ref of one. */

     

       92
       92
       -
       export type SubscriptionHandlerArg<T, R> = MaybeRef<SubscriptionHandler<T, R>>;

     

       89
       89
       +
       export type SubscriptionHandlerArg<T, R> =

     

       90
       90
       +
         | Ref<SubscriptionHandler<T, R>>

     

       91
       91
       +
         | SubscriptionHandler<T, R>;

     

       93
       92
        
       

     

       94
       93
        
       /** State of the current query, your {@link useSubscription} function is executing.

     

       95
       94
        
        *

     
···

       182
       181
        
         executeSubscription(opts?: Partial<OperationContext>): void;

     

       183
       182
        
       }

     

       184
       183
        
       

     

       185
       185
       -
       const watchOptions = {

     

       186
       186
       -
         flush: 'pre' as const,

     

       187
       187
       -
       };

     

       188
       188
       -
       

     

       189
       184
        
       /** Function to run a GraphQL subscription and get reactive GraphQL results.

     

       190
       185
        
        *

     

       191
       186
        
        * @param args - a {@link UseSubscriptionArgs} object, to pass a `query`, `variables`, and options.

     
···

       229
       224
        
         V extends AnyVariables = AnyVariables,

     

       230
       225
        
       >(

     

       231
       226
        
         args: UseSubscriptionArgs<T, V>,

     

       232
       232
       -
         handler?: MaybeRef<SubscriptionHandler<T, R>>

     

       227
       227
       +
         handler?: SubscriptionHandlerArg<T, R>

     

       233
       228
        
       ): UseSubscriptionResponse<T, R, V> {

     

       234
       229
        
         return callUseSubscription(args, handler);

     

       235
       230
        
       }

     
···

       239
       234
        
         R = T,

     

       240
       235
        
         V extends AnyVariables = AnyVariables,

     

       241
       236
        
       >(

     

       242
       242
       -
         _args: UseSubscriptionArgs<T, V>,

     

       243
       243
       -
         handler?: MaybeRef<SubscriptionHandler<T, R>>,

     

       237
       237
       +
         args: UseSubscriptionArgs<T, V>,

     

       238
       238
       +
         handler?: SubscriptionHandlerArg<T, R>,

     

       244
       239
        
         client: Ref<Client> = useClient(),

     

       245
       245
       -
         stops: WatchStopHandle[] = []

     

       240
       240
       +
         stops?: WatchStopHandle[]

     

       246
       241
        
       ): UseSubscriptionResponse<T, R, V> {

     

       247
       247
       -
         const args = reactive(_args) as UseSubscriptionArgs<T, V>;

     

       248
       248
       -
       

     

       249
       242
        
         const data: Ref<R | undefined> = ref();

     

       250
       250
       -
         const stale: Ref<boolean> = ref(false);

     

       251
       251
       -
         const fetching: Ref<boolean> = ref(false);

     

       252
       252
       -
         const error: Ref<CombinedError | undefined> = shallowRef();

     

       253
       253
       -
         const operation: Ref<Operation<T, V> | undefined> = shallowRef();

     

       254
       254
       -
         const extensions: Ref<Record<string, any> | undefined> = shallowRef();

     

       255
       243
        
       

     

       256
       256
       -
         const scanHandler = ref(handler);

     

       257
       257
       -
         const isPaused: Ref<boolean> = ref(!!unref(args.pause));

     

       258
       258
       -
         if (isRef(args.pause) || typeof args.pause === 'function') {

     

       259
       259
       -
           stops.push(watch(args.pause, value => (isPaused.value = value)));

     

       260
       260
       -
         }

     

       244
       244
       +
         const { fetching, operation, extensions, stale, error } = useRequestState<

     

       245
       245
       +
           T,

     

       246
       246
       +
           V

     

       247
       247
       +
         >();

     

       261
       248
        
       

     

       262
       262
       -
         const input = shallowRef({

     

       263
       263
       -
           request: createRequest<T, V>(unref(args.query), unref(args.variables) as V),

     

       264
       264
       -
           isPaused: isPaused.value,

     

       265
       265
       -
         });

     

       249
       249
       +
         const { isPaused, source, pause, resume, execute, teardown } = useClientState(

     

       250
       250
       +
           args,

     

       251
       251
       +
           client,

     

       252
       252
       +
           'executeSubscription'

     

       253
       253
       +
         );

     

       266
       254
        
       

     

       267
       267
       -
         const source: Ref<Source<OperationResult<T, V>> | undefined> = ref();

     

       255
       255
       +
         const teardownSubscription = watchEffect(onInvalidate => {

     

       256
       256
       +
           if (source.value) {

     

       257
       257
       +
             fetching.value = true;

     

       268
       258
        
       

     

       269
       269
       -
         stops.push(

     

       270
       270
       -
           watchEffect(() => {

     

       271
       271
       -
             updateShallowRef(input, {

     

       272
       272
       -
               request: createRequest<T, V>(

     

       273
       273
       -
                 unref(args.query),

     

       274
       274
       -
                 unref(args.variables) as V

     

       275
       275
       -
               ),

     

       276
       276
       -
               isPaused: isPaused.value,

     

       277
       277
       -
             });

     

       278
       278
       -
           }, watchOptions)

     

       279
       279
       -
         );

     

       259
       259
       +
             onInvalidate(

     

       260
       260
       +
               pipe(

     

       261
       261
       +
                 source.value,

     

       262
       262
       +
                 onEnd(() => {

     

       263
       263
       +
                   fetching.value = false;

     

       264
       264
       +
                 }),

     

       265
       265
       +
                 subscribe(result => {

     

       266
       266
       +
                   fetching.value = true;

     

       267
       267
       +
                   error.value = result.error;

     

       268
       268
       +
                   extensions.value = result.extensions;

     

       269
       269
       +
                   stale.value = !!result.stale;

     

       270
       270
       +
                   operation.value = result.operation;

     

       280
       271
        
       

     

       281
       281
       -
         stops.push(

     

       282
       282
       -
           watchEffect(() => {

     

       283
       283
       -
             source.value = !isPaused.value

     

       284
       284
       -
               ? client.value.executeSubscription<T, V>(input.value.request, {

     

       285
       285
       -
                   ...unref(args.context),

     

       272
       272
       +
                   if (result.data != null && handler) {

     

       273
       273
       +
                     const cb = isRef(handler) ? handler.value : handler;

     

       274
       274
       +
                     if (typeof cb === 'function') {

     

       275
       275
       +
                       data.value = cb(data.value, result.data);

     

       276
       276
       +
                       return;

     

       277
       277
       +
                     }

     

       278
       278
       +
                   }

     

       279
       279
       +
                   data.value = result.data as R;

     

       286
       280
        
                 })

     

       287
       287
       -
               : undefined;

     

       288
       288
       -
           }, watchOptions)

     

       289
       289
       -
         );

     

       281
       281
       +
               ).unsubscribe

     

       282
       282
       +
             );

     

       283
       283
       +
           } else {

     

       284
       284
       +
             fetching.value = false;

     

       285
       285
       +
           }

     

       286
       286
       +
         });

     

       290
       287
        
       

     

       291
       291
       -
         stops.push(

     

       292
       292
       -
           watchEffect(onInvalidate => {

     

       293
       293
       -
             if (source.value) {

     

       294
       294
       -
               fetching.value = true;

     

       295
       295
       -
       

     

       296
       296
       -
               onInvalidate(

     

       297
       297
       -
                 pipe(

     

       298
       298
       -
                   source.value,

     

       299
       299
       -
                   onEnd(() => {

     

       300
       300
       -
                     fetching.value = false;

     

       301
       301
       -
                   }),

     

       302
       302
       -
                   subscribe(result => {

     

       303
       303
       -
                     fetching.value = true;

     

       304
       304
       -
                     data.value =

     

       305
       305
       -
                       result.data != null

     

       306
       306
       -
                         ? typeof scanHandler.value === 'function'

     

       307
       307
       -
                           ? scanHandler.value(data.value as any, result.data)

     

       308
       308
       -
                           : result.data

     

       309
       309
       -
                         : (result.data as any);

     

       310
       310
       -
                     error.value = result.error;

     

       311
       311
       -
                     extensions.value = result.extensions;

     

       312
       312
       -
                     stale.value = !!result.stale;

     

       313
       313
       -
                     operation.value = result.operation;

     

       314
       314
       -
                   })

     

       315
       315
       -
                 ).unsubscribe

     

       316
       316
       -
               );

     

       317
       317
       -
             } else {

     

       318
       318
       -
               fetching.value = false;

     

       319
       319
       -
             }

     

       320
       320
       -
           }, watchOptions)

     

       321
       321
       -
         );

     

       288
       288
       +
         stops && stops.push(teardown, teardownSubscription);

     

       322
       289
        
       

     

       323
       290
        
         const state: UseSubscriptionResponse<T, R, V> = {

     

       324
       291
        
           data,

     
···

       328
       295
        
           extensions,

     

       329
       296
        
           fetching,

     

       330
       297
        
           isPaused,

     

       298
       298
       +
           pause,

     

       299
       299
       +
           resume,

     

       331
       300
        
           executeSubscription(

     

       332
       301
        
             opts?: Partial<OperationContext>

     

       333
       302
        
           ): UseSubscriptionResponse<T, R, V> {

     

       334
       334
       -
             source.value = client.value.executeSubscription<T, V>(

     

       335
       335
       -
               input.value.request,

     

       336
       336
       -
               {

     

       337
       337
       -
                 ...unref(args.context),

     

       338
       338
       -
                 ...opts,

     

       339
       339
       -
               }

     

       340
       340
       -
             );

     

       341
       341
       -
       

     

       303
       303
       +
             execute(opts);

     

       342
       304
        
             return state;

     

       343
       343
       -
           },

     

       344
       344
       -
           pause() {

     

       345
       345
       -
             isPaused.value = true;

     

       346
       346
       -
           },

     

       347
       347
       -
           resume() {

     

       348
       348
       -
             isPaused.value = false;

     

       349
       305
        
           },

     

       350
       306
        
         };

     

       351
       307

+154 -28

packages/vue-urql/src/utils.ts

···

       1
       1
       -
       import type { GraphQLRequest, AnyVariables } from '@urql/core';

     

       2
       2
       -
       import type { Ref, ShallowRef } from 'vue';

     

       3
       3
       -
       import { isRef } from 'vue';

     

       1
       1
       +
       import type {

     

       2
       2
       +
         AnyVariables,

     

       3
       3
       +
         Client,

     

       4
       4
       +
         CombinedError,

     

       5
       5
       +
         DocumentInput,

     

       6
       6
       +
         Operation,

     

       7
       7
       +
         OperationContext,

     

       8
       8
       +
         OperationResult,

     

       9
       9
       +
         OperationResultSource,

     

       10
       10
       +
       } from '@urql/core';

     

       11
       11
       +
       import { createRequest } from '@urql/core';

     

       12
       12
       +
       import type { Ref } from 'vue';

     

       13
       13
       +
       import { watchEffect, isReadonly, computed, ref, shallowRef, isRef } from 'vue';

     

       14
       14
       +
       import type { UseSubscriptionArgs } from './useSubscription';

     

       15
       15
       +
       import type { UseQueryArgs } from './useQuery';

     

       4
       16
        
       

     

       5
       17
        
       export type MaybeRef<T> = T | (() => T) | Ref<T>;

     

       6
       18
        
       export type MaybeRefObj<T> = T extends {}

     

       7
       19
        
         ? { [K in keyof T]: MaybeRef<T[K]> }

     

       8
       20
        
         : T;

     

       9
       21
        
       

     

       10
       10
       -
       export const unref = <T>(maybeRef: MaybeRef<T>): T =>

     

       22
       22
       +
       const unwrap = <T>(maybeRef: MaybeRef<T>): T =>

     

       11
       23
        
         typeof maybeRef === 'function'

     

       12
       24
        
           ? (maybeRef as () => T)()

     

       13
       25
        
           : maybeRef != null && isRef(maybeRef)

     

       14
       26
        
           ? maybeRef.value

     

       15
       27
        
           : maybeRef;

     

       16
       28
        
       

     

       17
       17
       -
       export interface RequestState<

     

       18
       18
       -
         Data = any,

     

       19
       19
       -
         Variables extends AnyVariables = AnyVariables,

     

       20
       20
       -
       > {

     

       21
       21
       -
         request: GraphQLRequest<Data, Variables>;

     

       22
       22
       -
         isPaused: boolean;

     

       23
       23
       -
       }

     

       29
       29
       +
       const isPlainObject = (value: any): boolean => {

     

       30
       30
       +
         if (typeof value !== 'object' || value === null) return false;

     

       31
       31
       +
         return (

     

       32
       32
       +
           value.constructor &&

     

       33
       33
       +
           Object.getPrototypeOf(value).constructor === Object.prototype.constructor

     

       34
       34
       +
         );

     

       35
       35
       +
       };

     

       36
       36
       +
       export const isArray = Array.isArray;

     

       37
       37
       +
       

     

       38
       38
       +
       const unwrapDeeply = <T>(input: T): T => {

     

       39
       39
       +
         input = isRef(input) ? (input.value as T) : input;

     

       40
       40
       +
       

     

       41
       41
       +
         if (typeof input === 'function') {

     

       42
       42
       +
           return unwrapDeeply(input()) as T;

     

       43
       43
       +
         }

     

       44
       44
       +
       

     

       45
       45
       +
         if (input && typeof input === 'object') {

     

       46
       46
       +
           if (isArray(input)) {

     

       47
       47
       +
             const length = input.length;

     

       48
       48
       +
             const out = new Array(length) as T;

     

       49
       49
       +
             let i = 0;

     

       50
       50
       +
             for (; i < length; i++) {

     

       51
       51
       +
               out[i] = unwrapDeeply(input[i]);

     

       52
       52
       +
             }

     

       53
       53
       +
       

     

       54
       54
       +
             return out;

     

       55
       55
       +
           } else if (isPlainObject(input)) {

     

       56
       56
       +
             const keys = Object.keys(input);

     

       57
       57
       +
             const length = keys.length;

     

       58
       58
       +
             let i = 0;

     

       59
       59
       +
             let key: string;

     

       60
       60
       +
             const out = {} as T;

     

       24
       61
        
       

     

       25
       25
       -
       export function createRequestState<

     

       26
       26
       -
         Data = any,

     

       27
       27
       -
         Variables extends AnyVariables = AnyVariables,

     

       28
       28
       -
       >(

     

       29
       29
       -
         request: GraphQLRequest<Data, Variables>,

     

       30
       30
       -
         isPaused: boolean

     

       31
       31
       -
       ): RequestState<Data, Variables> {

     

       32
       32
       -
         return { request, isPaused };

     

       33
       33
       -
       }

     

       62
       62
       +
             for (; i < length; i++) {

     

       63
       63
       +
               key = keys[i];

     

       64
       64
       +
               out[key] = unwrapDeeply(input[key]);

     

       65
       65
       +
             }

     

       34
       66
        
       

     

       35
       35
       -
       export const updateShallowRef = <T extends Record<string, any>>(

     

       36
       36
       -
         ref: ShallowRef<T>,

     

       37
       37
       -
         next: T

     

       38
       38
       -
       ) => {

     

       39
       39
       -
         for (const key in next) {

     

       40
       40
       -
           if (ref.value[key] !== next[key]) {

     

       41
       41
       -
             ref.value = next;

     

       42
       42
       -
             return;

     

       67
       67
       +
             return out;

     

       43
       68
        
           }

     

       44
       69
        
         }

     

       70
       70
       +
       

     

       71
       71
       +
         return input;

     

       45
       72
        
       };

     

       73
       73
       +
       

     

       74
       74
       +
       export const createRequestWithArgs = <

     

       75
       75
       +
         T = any,

     

       76
       76
       +
         V extends AnyVariables = AnyVariables,

     

       77
       77
       +
       >(

     

       78
       78
       +
         args:

     

       79
       79
       +
           | UseQueryArgs<T, V>

     

       80
       80
       +
           | UseSubscriptionArgs<T, V>

     

       81
       81
       +
           | { query: MaybeRef<DocumentInput<T, V>>; variables: V }

     

       82
       82
       +
       ) => {

     

       83
       83
       +
         return createRequest<T, V>(

     

       84
       84
       +
           unwrap(args.query),

     

       85
       85
       +
           unwrapDeeply(args.variables) as V

     

       86
       86
       +
         );

     

       87
       87
       +
       };

     

       88
       88
       +
       

     

       89
       89
       +
       export const useRequestState = <

     

       90
       90
       +
         T = any,

     

       91
       91
       +
         V extends AnyVariables = AnyVariables,

     

       92
       92
       +
       >() => {

     

       93
       93
       +
         const stale: Ref<boolean> = ref(false);

     

       94
       94
       +
         const fetching: Ref<boolean> = ref(false);

     

       95
       95
       +
         const error: Ref<CombinedError | undefined> = shallowRef();

     

       96
       96
       +
         const operation: Ref<Operation<T, V> | undefined> = shallowRef();

     

       97
       97
       +
         const extensions: Ref<Record<string, any> | undefined> = shallowRef();

     

       98
       98
       +
         return {

     

       99
       99
       +
           stale,

     

       100
       100
       +
           fetching,

     

       101
       101
       +
           error,

     

       102
       102
       +
           operation,

     

       103
       103
       +
           extensions,

     

       104
       104
       +
         };

     

       105
       105
       +
       };

     

       106
       106
       +
       

     

       107
       107
       +
       export function useClientState<T = any, V extends AnyVariables = AnyVariables>(

     

       108
       108
       +
         args: UseQueryArgs<T, V> | UseSubscriptionArgs<T, V>,

     

       109
       109
       +
         client: Ref<Client>,

     

       110
       110
       +
         method: keyof Pick<Client, 'executeSubscription' | 'executeQuery'>

     

       111
       111
       +
       ) {

     

       112
       112
       +
         const source: Ref<OperationResultSource<OperationResult<T, V>> | undefined> =

     

       113
       113
       +
           shallowRef();

     

       114
       114
       +
       

     

       115
       115
       +
         const isPaused: Ref<boolean> = isRef(args.pause)

     

       116
       116
       +
           ? args.pause

     

       117
       117
       +
           : typeof args.pause === 'function'

     

       118
       118
       +
           ? computed(args.pause)

     

       119
       119
       +
           : ref(!!args.pause);

     

       120
       120
       +
       

     

       121
       121
       +
         const request = computed(() => createRequestWithArgs(args));

     

       122
       122
       +
       

     

       123
       123
       +
         const requestOptions = computed(() => {

     

       124
       124
       +
           return 'requestPolicy' in args

     

       125
       125
       +
             ? {

     

       126
       126
       +
                 requestPolicy: unwrap(args.requestPolicy),

     

       127
       127
       +
                 ...unwrap(args.context),

     

       128
       128
       +
               }

     

       129
       129
       +
             : {

     

       130
       130
       +
                 ...unwrap(args.context),

     

       131
       131
       +
               };

     

       132
       132
       +
         });

     

       133
       133
       +
       

     

       134
       134
       +
         const pause = () => {

     

       135
       135
       +
           if (!isReadonly(isPaused)) {

     

       136
       136
       +
             isPaused.value = true;

     

       137
       137
       +
           }

     

       138
       138
       +
         };

     

       139
       139
       +
       

     

       140
       140
       +
         const resume = () => {

     

       141
       141
       +
           if (!isReadonly(isPaused)) {

     

       142
       142
       +
             isPaused.value = false;

     

       143
       143
       +
           }

     

       144
       144
       +
         };

     

       145
       145
       +
       

     

       146
       146
       +
         const executeRaw = (opts?: Partial<OperationContext>) => {

     

       147
       147
       +
           return client.value[method]<T, V>(request.value, {

     

       148
       148
       +
             ...requestOptions.value,

     

       149
       149
       +
             ...opts,

     

       150
       150
       +
           });

     

       151
       151
       +
         };

     

       152
       152
       +
       

     

       153
       153
       +
         const execute = (opts?: Partial<OperationContext>) => {

     

       154
       154
       +
           source.value = executeRaw(opts);

     

       155
       155
       +
         };

     

       156
       156
       +
       

     

       157
       157
       +
         // it's important to use `watchEffect()` here instead of `watch()`

     

       158
       158
       +
         // because it listening for reactive variables inside `executeRaw()` function

     

       159
       159
       +
         const teardown = watchEffect(() => {

     

       160
       160
       +
           source.value = !isPaused.value ? executeRaw() : undefined;

     

       161
       161
       +
         });

     

       162
       162
       +
       

     

       163
       163
       +
         return {

     

       164
       164
       +
           source,

     

       165
       165
       +
           isPaused,

     

       166
       166
       +
           pause,

     

       167
       167
       +
           resume,

     

       168
       168
       +
           execute,

     

       169
       169
       +
           teardown,

     

       170
       170
       +
         };

     

       171
       171
       +
       }