Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

hotfix: graphql connection error handler #4523

Merged
merged 7 commits into from
Nov 12, 2024
Merged

hotfix: graphql connection error handler #4523

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
69d4f87
fix: graphql connection error handler
anwarulislam Nov 7, 2024
0ae40f5
fix: prevent infinite loading state while connecting
jamesgeorge007 Nov 8, 2024
bf21040
fix: handle graphql connection error and display error message
anwarulislam Nov 9, 2024
82cbed4
fix: account for connection error state
jamesgeorge007 Nov 11, 2024
53a1858
chore: prevent showing connection error toast while sending a request
jamesgeorge007 Nov 11, 2024
a7dfaab
chore: show an error toast if any schema fetch attempt fails
jamesgeorge007 Nov 11, 2024
c2e5e7f
fix: toggle connection state if schema fetch attempt fails
jamesgeorge007 Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/hoppscotch-common/locales/en.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@
},
"graphql": {
"connection_switch_confirm": "Do you want to connect with the latest GraphQL endpoint?",
"connection_error_http": "Failed to fetch GraphQL Schema due to network error.",
"connection_switch_new_url": "Switching to a tab will disconnected you from the active GraphQL connection. New connection URL is",
"connection_switch_url": "You're connected to a GraphQL endpoint the connection URL is",
"mutations": "Mutations",
Expand Down
41 changes: 30 additions & 11 deletions packages/hoppscotch-common/src/helpers/graphql/connection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,11 @@ export type GQLResponseEvent =
}
}

export type ConnectionState = "CONNECTING" | "CONNECTED" | "DISCONNECTED"
export type ConnectionState =
| "CONNECTING"
| "CONNECTED"
| "DISCONNECTED"
| "ERROR"
export type SubscriptionState = "SUBSCRIBING" | "SUBSCRIBED" | "UNSUBSCRIBED"

const GQL = {
Expand Down Expand Up @@ -100,10 +104,7 @@ export const gqlMessageEvent = ref<GQLResponseEvent | "reset">()

export const schemaString = computed(() => {
if (!connection.schema) return ""

return printSchema(connection.schema, {
commentDescriptions: true,
})
return printSchema(connection.schema)
})

export const queryFields = computed(() => {
Expand Down Expand Up @@ -166,14 +167,19 @@ export const connect = async (url: string, headers: GQLHeader[]) => {
)
}

// Polling
connection.state = "CONNECTED"
connection.state = "CONNECTING"

const poll = async () => {
await getSchema(url, headers)
timeoutSubscription = setTimeout(() => {
poll()
}, GQL_SCHEMA_POLL_INTERVAL)
try {
await getSchema(url, headers)
// polling for schema
if (connection.state !== "CONNECTED") connection.state = "CONNECTED"
timeoutSubscription = setTimeout(() => {
poll()
}, GQL_SCHEMA_POLL_INTERVAL)
} catch (error) {
console.error(error)
}
}

await poll()
Expand Down Expand Up @@ -221,6 +227,8 @@ const getSchema = async (url: string, headers: GQLHeader[]) => {
const res = await interceptorService.runRequest(reqOptions).response

if (E.isLeft(res)) {
connection.state = "ERROR"

if (
res.left !== "cancellation" &&
res.left.error === "NO_PW_EXT_HOOK" &&
Expand All @@ -237,6 +245,17 @@ const getSchema = async (url: string, headers: GQLHeader[]) => {
throw new Error(res.left.toString())
}

if (res.right.status !== 200) {
connection.state = "ERROR"
connection.error = {
type: "HTTP_ERROR",
message: (t: ReturnType<typeof getI18n>) =>
t("graphql.connection_error_http"),
component: undefined,
}
anwarulislam marked this conversation as resolved.
Show resolved Hide resolved
throw new Error("Failed to fetch schema. Status: " + res.right.status)
}

const data = res.right

// HACK : Temporary trailing null character issue from the extension fix
Expand Down
10 changes: 9 additions & 1 deletion packages/hoppscotch-common/src/pages/graphql.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@
import { usePageHead } from "@composables/head"
import { useI18n } from "@composables/i18n"
import { useService } from "dioc/vue"
import { computed, onBeforeUnmount, ref } from "vue"
import { computed, onBeforeUnmount, ref, watch } from "vue"
import { useToast } from "~/composables/toast"
import { defineActionHandler } from "~/helpers/actions"
import { connection, disconnect } from "~/helpers/graphql/connection"
import { getDefaultGQLRequest } from "~/helpers/graphql/default"
Expand All @@ -97,6 +98,7 @@ import { HoppTab } from "~/services/tab"
import { GQLTabService } from "~/services/tab/graphql"

const t = useI18n()
const toast = useToast()
const tabs = useService(GQLTabService)

const currentTabID = computed(() => tabs.currentTabID.value)
Expand Down Expand Up @@ -176,6 +178,12 @@ const onTabUpdate = (tab: HoppTab<HoppGQLDocument>) => {
tabs.updateTab(tab)
}

const connectionError = computed(() => connection.error)

watch(connectionError, (error) => {
if (error) toast.error(error.message(t))
})

onBeforeUnmount(() => {
if (connection.state === "CONNECTED") {
disconnect()
Expand Down