JSON Parser Error raised with unexpected HTML response from Shopfiy #1107

ClaytonPassmore · 2023-01-31T22:12:47Z

Issue summary

Occasionally Shopify will 500 and respond with HTML instead of JSON. When this happens, the client attempts to parse the response as JSON which ultimately raises a JSON::ParserError.

shopify_api version: 12.4.0
Ruby version: 3.2.0
Operating system: Ubuntu 22.04 LTS

Below is an example response from Shopify during a request to update a metafield on a product:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8" />
    <meta name="referrer" content="never" />
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Something went wrong</title>
    <style type="text/css">
        *{box-sizing:border-box;margin:0;padding:0}html{font-family:"Helvetica Neue",Helvetica,Arial,sans-serif;background:#F1F1F1;font-size:62.5%;color:#303030;min-height:100%}body{padding:0;margin:0;line-height:2.7rem}a{color:#303030;border-bottom:1px solid #303030;text-decoration:none;padding-bottom:1rem;transition:border-color 0.2s ease-in}a:hover{border-bottom-color:#A9A9A9}h1{font-size:1.8rem;font-weight:400;margin:0 0 1.4rem 0}p{font-size:1.5rem;margin:0}.page{padding:4rem 3.5rem;margin:0;display:flex;min-height:100vh;flex-direction:column}.text-container--main{flex:1;display:flex;align-items:start;margin-bottom:1.6rem}.action{border:1px solid #A9A9A9;padding:1.2rem 2.5rem;border-radius:6px;text-decoration:none;margin-top:1.6rem;display:inline-block;font-size:1.5rem;transition:border-color 0.2s ease-in}.action:hover{border-color:#000}@media all and (min-width:500px){.text-container--main{align-items:center}.page{padding:7.5rem 10.5rem}}
    </style>
</head>

<body class="status-error status-code-500">
<div class="page">
    <div class="text-container text-container--main">
        <div>
            <h1 data-i18n="content-title">Something went wrong</h1>
            <p data-i18n="try-refreshing">There was a problem loading this website</p>
            <p data-i18n="try-again">Try refreshing the page.</p>
            <a href="." class="action" data-i18n="refresh-page">Refresh Page</a>
        </div>
    </div>
</div>
</body>

</html>

<script>
  var t = {
    "cs": {
      "title": "Něco se pokazilo",
      "content-title": "Při načítání této webové stránky došlo k chybě",
      "try-refreshing": "Zkuste stránku obnovit.",
      "try-again": "Pokud se stránka ani přesto nenačte, zkuste to znovu za pár minut.",
      "refresh-page": "Obnovit stránku"
    },
    "nb": {
      "title": "Noe gikk galt",
      "content-title": "Det oppsto et problem ved lasting av denne nettsiden",
      "try-refreshing": "Prøv å oppdatere siden.",
      "try-again": "Hvis nettstedet fortsatt ikke lastes inn, kan du prøve igjen om noen minutter.",
      "refresh-page": "Oppdater siden"
    },
    "th": {
      "title": "เกิดข้อผิดพลาดขึ้น",
      "content-title": "เกิดปัญหาในการโหลดเว็บไซต์นี้",
      "try-refreshing": "โปรดรีเฟรชหน้านี้อีกครั้ง",
      "try-again": "หากเว็บไซต์ยังไม่โหลด โปรดลองอีกครั้งในอีกสักครู่",
      "refresh-page": "รีเฟรชหน้า"
    },
    "pt-BR": {
      "title": "Houve um erro.",
      "content-title": "Houve um problema ao carregar este site",
      "try-refreshing": "Tente atualizar a página.",
      "try-again": "Se o site ainda não carregar, tente novamente dentro de alguns minutos.",
      "refresh-page": "Atualizar a página"
    },
    "es": {
      "title": "Algo salió mal.",
      "content-title": "Se ha producido un error al descargar el sitio",
      "try-refreshing": "Intenta actualizar la página.",
      "try-again": "Si el sitio no se descarga, por favor, inténtalo en unos minutos.",
      "refresh-page": "Actualizar la página"
    },
    "ko": {
      "title": "문제가 발생했습니다.",
      "content-title": "이 페이지를 로드하는 중 문제가 발생했습니다.",
      "try-refreshing": "페이지를 새로 고침해 보십시오.",
      "try-again": "그래도 사이트가 로드되지 않으면 몇 분 후에 다시 시도하십시오.",
      "refresh-page": "페이지 새로 고침"
    },
    "da": {
      "title": "Der opstod en fejl",
      "content-title": "Der opstod en fejl under indlæsning af dette website",
      "try-refreshing": "Prøv at opdatere siden.",
      "try-again": "Hvis websitet ikke indlæses, kan du prøve igen om nogle få minutter.",
      "refresh-page": "Opdatér siden"
    },
    "fi": {
      "title": "Jotain meni pieleen",
      "content-title": "Tämän verkkosivuston lataamisessa oli ongelma",
      "try-refreshing": "Yritä päivittää sivu.",
      "try-again": "Jos sivusto ei vieläkään lataudu, yritä uudelleen muutaman minuutin kuluttua.",
      "refresh-page": "Päivitä sivu"
    },
    "pt-PT": {
      "title": "Ocorreu um erro",
      "content-title": "Ocorreu um erro ao carregar este site",
      "try-refreshing": "Experimente atualizar esta página.",
      "try-again": "Se o site continua a não carregar, tente novamente dentro de alguns minutos.",
      "refresh-page": "Atualizar página"
    },
    "de": {
      "title": "Irgendetwas ist schiefgelaufen.",
      "content-title": "Beim Laden dieser Website ist ein Fehler aufgetreten.",
      "try-refreshing": "Versuche, die Seite zu aktualisieren.",
      "try-again": "Wenn die Seite immer noch nicht geladen wird, versuche es bitte in ein paar Minuten erneut.",
      "refresh-page": "Seite neu laden"
    },
    "it": {
      "title": "Si è verificato un errore",
      "content-title": "Si è verificato un problema nel caricamento di questo sito web",
      "try-refreshing": "Prova ad aggiornare la pagina.",
      "try-again": "Se il sito ancora non si carica, per favore riprova tra qualche minuto.",
      "refresh-page": "Aggiorna pagina"
    },
    "pl": {
      "title": "Coś poszło nie tak",
      "content-title": "Podczas ładowania tej strony internetowej wystąpił problem",
      "try-refreshing": "Spróbuj odświeżyć stronę.",
      "try-again": "Jeśli strona nadal się nie ładuje, spróbuj ponownie za kilka minut.",
      "refresh-page": "Odśwież stronę"
    },
    "sv": {
      "title": "Ett fel uppstod",
      "content-title": "Det gick inte att ladda den här webbplatsen",
      "try-refreshing": "Försök att uppdatera sidan.",
      "try-again": "Försök igen om några minuter om webbplatsen fortfarande inte har laddats.",
      "refresh-page": "Uppdatera sida"
    },
    "en": {
      "title": "Something went wrong",
      "content-title": "There was a problem loading this website",
      "try-refreshing": "Try refreshing the page.",
      "try-again": "If the site still doesn't load, please try again in a few minutes.",
      "refresh-page": "Refresh Page"
    },
    "hi": {
      "title": "कुछ गलत हुआ",
      "content-title": "इस वेबसाइट को लोड करने में समस्या हुई",
      "try-refreshing": "पृष्ठ रीफ़्रेश करके देखें.",
      "try-again": "यदि साइट अभी तक लोड नहीं हुई है, तो कृपया कुछ मिनटों में फिर से कोशिश करें.",
      "refresh-page": "पेज को रीफ़्रेश करें"
    },
    "ja": {
      "title": "問題が発生しているようです",
      "content-title": "このウェブサイトを読み込む際に問題が発生しました",
      "try-refreshing": "ページを更新してみてください。",
      "try-again": "サイトが読み込まれない場合は、数分後にもう一度お試しください。",
      "refresh-page": "ページを更新する"
    },
    "fr": {
      "title": "Une erreur s'est produite",
      "content-title": "Un problème est survenu lors du chargement de ce site",
      "try-refreshing": "Essayez d'actualiser la page.",
      "try-again": "Si le site ne charge toujours pas, veuillez réessayer dans quelques minutes.",
      "refresh-page": "Rafraîchir la page"
    },
    "zh-TW": {
      "title": "出了點問題",
      "content-title": "系統載入此網站時發生問題",
      "try-refreshing": "請嘗試重新整理此頁面。",
      "try-again": "如果網站仍未載入，請幾分鐘後再試一次。",
      "refresh-page": "重新整理頁面"
    },
    "ms": {
      "title": "Sesuatu tidak kena",
      "content-title": "Terdapat masalah memuatkan laman web ini",
      "try-refreshing": "Cuba segarkan semula halaman.",
      "try-again": "Jika laman web ini masih tidak memuatkan, sila cuba lagi dalam beberapa minit.",
      "refresh-page": "Segarkan semula Halaman"
    },
    "tr": {
      "title": "Bir sorun oluştu",
      "content-title": "Bu web sitesi yüklenirken sorun oluştu",
      "try-refreshing": "Sayfayı yenilemeyi deneyin.",
      "try-again": "Sayfa hâlâ yüklenmiyorsa lütfen birkaç dakika sonra tekrar deneyin.",
      "refresh-page": "Sayfayı Yenile"
    },
    "vi": {
      "title": "Đã xảy ra lỗi",
      "content-title": "Đã xảy ra sự cố khi tải trang web này",
      "try-refreshing": "Thử làm mới trang.",
      "try-again": "Nếu trang web vẫn không tải được, vui lòng thử lại sau ít phút.",
      "refresh-page": "Tải lại trang"
    },
    "zh-CN": {
      "title": "出现错误",
      "content-title": "加载此网站时出现问题",
      "try-refreshing": "请尝试刷新页面。",
      "try-again": "如果网站仍未加载，请在几分钟后重试。",
      "refresh-page": "刷新页面"
    },
    "nl": {
      "title": "Er ging iets mis",
      "content-title": "Er is een probleem opgetreden bij het laden van deze website",
      "try-refreshing": "Laad de pagina opnieuw.",
      "try-again": "Als de site nog steeds niet laadt, probeer het over een paar minuten opnieuw.",
      "refresh-page": "Pagina opnieuw laden"
    }
  };
  var language = navigator.languages && navigator.languages[0] || // Chrome / Firefox
    navigator.language ||   // All browsers
    navigator.userLanguage || // IE <= 10
    "en";
  language = language.split("-")[0]; // Strip country code
  translations = t[language] || t["en"];
  // Replace content on screen
  for (var id in translations) {
    target = document.querySelector("[data-i18n=" + id + "]");
    if (target != undefined) {
      target.innerHTML = translations[id];
    }
  }
  // Replace title tage
  document.title = translations["title"];
  // Replace language tag
  if (t[language]) { document.getElementsByTagName('html')[0].setAttribute('lang', language); };
</script>

Expected behavior

This should raise a ShopifyAPI::Errors::HttpResponseError since Shopify is responding with a 500 status code.

Actual behavior

The client raises a JSON::ParserError (which is not something I feel confident rescuing in my application code).

Steps to reproduce the problem

This is incredibly difficult to reproduce in a real environment because it happens so infrequently. That said, it's trivial to reproduce it with a test case.

In test/clients/http_client_test.rb, add the following:

      def test_request_with_non_json_response_body
        @success_body = {}

        stub_request(@request.http_method, "https://#{@shop}#{@base_path}/#{@request.path}")
          .with(body: @request.body.to_json, query: @request.query, headers: @expected_headers)
          .to_return(body: "<!DOCTYPE html><html></html>", headers: @response_headers, status: 500)

        verify_http_request
      end

Test results:

The text was updated successfully, but these errors were encountered:

ClaytonPassmore · 2023-01-31T22:23:02Z

This may be a duplicate of #1091

jonathan-saindon · 2023-03-16T20:28:42Z

I experience the same issue as what @ClaytonPassmore is describing here.

This JSON::ParserError comes up sporadically when Shopify decides to return the 500 error as an HTML page rather than a JSON response. Even if I do rescue the error in my code, this response from Shopify gives in hindsight as to why my request caused the 500 error to begin with.

nelsonwittwer · 2023-03-21T15:07:37Z

agreed, this is a duplicate of #1091. This is on our radar for this next release. Thanks for your patience and for letting us know what you are seeing!

ClaytonPassmore mentioned this issue Feb 13, 2023

Handle JSON::ParserError when http response is HTML and raise ShopifyAPI::Errors::HttpResponseError #1113

Merged

5 tasks

ClaytonPassmore mentioned this issue Mar 16, 2023

How to handle 500 errors with Rest API #1119

Closed

nelsonwittwer closed this as completed Mar 21, 2023

kaarelss mentioned this issue Mar 22, 2023

json parse error when the server returns non-json content #1128

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JSON Parser Error raised with unexpected HTML response from Shopfiy #1107

JSON Parser Error raised with unexpected HTML response from Shopfiy #1107

ClaytonPassmore commented Jan 31, 2023

ClaytonPassmore commented Jan 31, 2023

jonathan-saindon commented Mar 16, 2023 •

edited

Loading

nelsonwittwer commented Mar 21, 2023

JSON Parser Error raised with unexpected HTML response from Shopfiy #1107

JSON Parser Error raised with unexpected HTML response from Shopfiy #1107

Comments

ClaytonPassmore commented Jan 31, 2023

Issue summary

Expected behavior

Actual behavior

Steps to reproduce the problem

ClaytonPassmore commented Jan 31, 2023

jonathan-saindon commented Mar 16, 2023 • edited Loading

nelsonwittwer commented Mar 21, 2023

jonathan-saindon commented Mar 16, 2023 •

edited

Loading