Open-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia
TypeScript apiapi-clientapi-restapi-testingdeveloper-toolsgraphqlhttphttp-clientpwarestrest-apispatestingtesting-toolstoolsvuevuejswebsocket
feat: add subscription support for useGQLQuery
Andrew Bastinddd29374ea6e
diff --git a/packages/hoppscotch-app/helpers/backend/GQLClient.ts b/packages/hoppscotch-app/helpers/backend/GQLClient.tsindex 79c6eeae0..fedad795c 100644--- a/packages/hoppscotch-app/helpers/backend/GQLClient.ts+++ b/packages/hoppscotch-app/helpers/backend/GQLClient.ts@@ -18,11 +18,13 @@ import {makeOperation,GraphQLRequest,createRequest,+ subscriptionExchange,} from "@urql/core"import { authExchange } from "@urql/exchange-auth"import { offlineExchange } from "@urql/exchange-graphcache"import { makeDefaultStorage } from "@urql/exchange-graphcache/default-storage"import { devtoolsExchange } from "@urql/devtools"+import { SubscriptionClient } from "subscriptions-transport-ws"import * as E from "fp-ts/Either"import * as TE from "fp-ts/TaskEither"import { pipe, constVoid } from "fp-ts/function"@@ -33,13 +35,14 @@ import { updatesDef } from "./caching/updates"import { resolversDef } from "./caching/resolvers"import schema from "./backend-schema.json"import {+ authIdToken$,getAuthIDToken,probableUser$,waitProbableLoginToConfirm,} from "~/helpers/fb/auth"const BACKEND_GQL_URL =- process.env.CONTEXT === "production"+ process.env.context === "production"? "https://api.hoppscotch.io/graphql": "https://api.hoppscotch.io/graphql"@@ -48,6 +51,18 @@ const storage = makeDefaultStorage({maxAge: 7,})+const subscriptionClient = new SubscriptionClient(+ process.env.context === "production"+ ? "wss://api.hoppscotch.io/graphql"+ : "wss://api.hoppscotch.io/graphql",+ {+ reconnect: true,+ connectionParams: () => ({+ authorization: `Bearer ${authIdToken$.value}`,+ }),+ }+)+export const client = createClient({url: BACKEND_GQL_URL,exchanges: [@@ -97,6 +112,9 @@ export const client = createClient({},}),fetchExchange,+ subscriptionExchange({+ forwardSubscription: (operation) => subscriptionClient.request(operation),+ }),],})@@ -106,6 +124,7 @@ type UseQueryOptions<T = any, V = object> = {query: TypedDocumentNode<T, V>variables?: MaybeRef<V>+ updateSubs?: MaybeRef<GraphQLRequest<any, object>[]>defer?: boolean}@@ -133,6 +152,8 @@ export const useGQLQuery = <DocType, DocVarType, DocErrorType extends string>(const isStale: Ref<boolean> = ref(true)const data: Ref<E.Either<GQLError<DocErrorType>, DocType>> = ref() as any+ if (!args.updateSubs) set(args, "updateSubs", [])+const isPaused: Ref<boolean> = ref(args.defer ?? false)const request: Ref<GraphQLRequest<DocType, DocVarType>> = ref(@@ -178,7 +199,22 @@ export const useGQLQuery = <DocType, DocVarType, DocErrorType extends string>(loading.value = trueisStale.value = false- onInvalidate(+ const invalidateStops = args.updateSubs!.map((sub) => {+ console.log("create sub")++ return wonkaPipe(+ client.executeSubscription(sub),+ onEnd(() => {+ if (source.value) execute()+ }),+ subscribe(() => {+ console.log("invalidate!")+ return execute()+ })+ ).unsubscribe+ })++ invalidateStops.push(wonkaPipe(source.value,onEnd(() => {@@ -220,6 +256,8 @@ export const useGQLQuery = <DocType, DocVarType, DocErrorType extends string>(})).unsubscribe)++ onInvalidate(() => invalidateStops.forEach((unsub) => unsub()))}})diff --git a/packages/hoppscotch-app/helpers/backend/caching/updates.ts b/packages/hoppscotch-app/helpers/backend/caching/updates.tsindex 2dad18248..d13e9c1fe 100644--- a/packages/hoppscotch-app/helpers/backend/caching/updates.ts+++ b/packages/hoppscotch-app/helpers/backend/caching/updates.ts@@ -1,6 +1,44 @@import { GraphCacheUpdaters, MyTeamsDocument } from "../graphql"export const updatesDef: GraphCacheUpdaters = {+ Subscription: {+ teamMemberAdded: (_r, { teamID }, cache, _info) => {+ debugger+ cache.invalidate(+ {+ __typename: "Team",+ id: teamID,+ },+ "teamMembers"+ )+ },+ teamMemberUpdated: (_r, { teamID }, cache, _info) => {+ cache.invalidate(+ {+ __typename: "Team",+ id: teamID,+ },+ "teamMembers"+ )++ cache.invalidate(+ {+ __typename: "Team",+ id: teamID,+ },+ "myRole"+ )+ },+ teamMemberRemoved: (_r, { teamID }, cache, _info) => {+ cache.invalidate(+ {+ __typename: "Team",+ id: teamID,+ },+ "teamMembers"+ )+ },+ },Mutation: {deleteTeam: (_r, { teamID }, cache, _info) => {cache.updateQuery(diff --git a/packages/hoppscotch-app/package.json b/packages/hoppscotch-app/package.jsonindex 8b867f5a0..a442a3943 100644--- a/packages/hoppscotch-app/package.json+++ b/packages/hoppscotch-app/package.json@@ -70,6 +70,7 @@"socket.io-client": "^4.2.0","socketio-wildcard": "^2.0.0","splitpanes": "^2.3.8",+ "subscriptions-transport-ws": "^0.9.19","tern": "^0.24.3","vue-apollo": "^3.0.8","vue-cli-plugin-apollo": "^0.22.2",diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 3e0903020..0ddb5abac 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -105,6 +105,7 @@ importers:stylelint: ^13.13.1stylelint-config-prettier: ^8.0.2stylelint-config-standard: ^22.0.0+ subscriptions-transport-ws: ^0.9.19tern: ^0.24.3ts-jest: ^27.0.5typescript: ^4.4.3@@ -121,7 +122,7 @@ importers:worker-loader: ^3.0.8yargs-parser: ^20.2.9dependencies:- '@apollo/client': [email protected]+ '@apollo/client': 3.4.16_9725b5bd6f8ccdf8972896e366c3daff'@hoppscotch/js-sandbox': link:../hoppscotch-js-sandbox'@nuxtjs/axios': 5.13.6'@nuxtjs/composition-api': [email protected]@@ -158,6 +159,7 @@ importers:socket.io-client: 4.2.0socketio-wildcard: 2.0.0splitpanes: 2.3.8+ subscriptions-transport-ws: [email protected]tern: 0.24.3vue-apollo: [email protected]vue-cli-plugin-apollo: [email protected]@@ -310,33 +312,6 @@ packages:zen-observable-ts: 1.1.0dev: false- /@apollo/client/[email protected]:- resolution: {integrity: sha512-iF4zEYwvebkri0BZQyv8zfavPfVEafsK0wkOofa6eC2yZu50J18uTutKtC174rjHZ2eyxZ8tV7NvAPKRT+OtZw==}- peerDependencies:- graphql: ^14.0.0 || ^15.0.0- react: ^16.8.0 || ^17.0.0- subscriptions-transport-ws: ^0.9.0- peerDependenciesMeta:- react:- optional: true- subscriptions-transport-ws:- optional: true- dependencies:- '@graphql-typed-document-node/core': [email protected]- '@wry/context': 0.6.1- '@wry/equality': 0.5.2- '@wry/trie': 0.3.1- graphql: 15.6.1- graphql-tag: [email protected]- hoist-non-react-statics: 3.3.2- optimism: 0.16.1- prop-types: 15.7.2- symbol-observable: 4.0.0- ts-invariant: 0.9.3- tslib: 2.3.1- zen-observable-ts: 1.1.0- dev: false-/@apollo/federation/[email protected]:resolution: {integrity: sha512-hMeRN9IPsIn+5J5SmWof0ODbvRjRj8mBNqbsm9Zjkqjbw6RTlcx90taMk7cYhcd/E+uTyLQt5cOSRVBx53cxbQ==}engines: {node: '>=12.13.0 <17.0'}@@ -3058,7 +3033,7 @@ packages:form-data: 4.0.0graphql: 15.6.1graphql-sse: [email protected]- graphql-ws: [email protected]+ graphql-ws: [email protected]is-promise: 4.0.0isomorphic-ws: [email protected]lodash: 4.17.21@@ -10432,8 +10407,8 @@ packages:graphql: 15.6.1dev: false- /graphql-ws/[email protected]:- resolution: {integrity: sha512-WQepPMGQQoqS2VsrI2I3RMLCVz3CW4/6ZqGV6ABDOwH4R62DzjxwMlwZbj6vhSI/7IM3/C911yITwgs77iO/hw==}+ /graphql-ws/[email protected]:+ resolution: {integrity: sha512-Okp3gE3vq9OoeqsYVbmzKvPcvlinKNXrfVajH7D3ul1UdCg2+K2zVYbWKmqxehkAZ+GKVfngK5fzyXSsfpe+pA==}engines: {node: '>=10'}peerDependencies:graphql: '>=0.11 <=16'