[nextjs] api route not returning response or json once deployed to Vercel in latest 7.29.0 #6670

Activity

1. wadehammes

   added

   Type: Bug

   on Jan 5, 2023
2. getsantry

   added

   Status: Untriaged

   on Jan 5, 2023
3. wadehammes commented on Jan 5, 2023

   

   wadehammes

   on Jan 5, 2023

   Author

   More actions

   Here is a the api route in question:

   import { NextApiRequest, NextApiResponse } from "next";
   
   const handler = async (req: NextApiRequest, res: NextApiResponse) => {
     const { secret, feedId, type } = req.query;
   
     // This secret key just allows us to make sure no one externally can hit this endpoint
     if (secret !== process.env.API_SECRET) {
       return res.status(401).json({ message: "Invalid token." });
     }
   
     if (!type) {
       return res.status(401).json({
         message: 'No type of either "reviews" or "feed" supplied as a parameter.',
       });
     }
   
     if (!feedId && type === "reviews") {
       return res.status(401).json({
         message: "No feed id supplied as a parameter to fetch reviews.",
       });
     }
   
     const apiUrl =
       feedId && type === "reviews"
         ? `https://embedsocial.com/admin/v2/api/reviews/reviews-filtered?feed_id=${feedId}&sort=created_on&per_page=200`
         : "https://embedsocial.com/admin/v2/api/reviews/feeds";
   
     try {
       const fetchReviews = await fetch(apiUrl, {
         method: "GET",
         headers: {
           Accept: "application/json",
           Authorization: `Bearer ${process.env.EMBED_SOCIAL_API_KEY}`,
           "Content-Type": "application/json; charset=utf-8",
         },
       });
   
       if (fetchReviews.ok) {
         const reviewsJson = await fetchReviews.json();
   
         if (reviewsJson.success) {
           res.status(200).json(reviewsJson);
         } else {
           res.status(400).json({ message: "Not able to fetch reviews json." });
         }
       }
     } catch (e) {
       res.status(400).json({ message: "Failed to fetch reviews." });
     }
   
     res.end();
   };
   
4. lforst commented on Jan 6, 2023

   

   lforst

   on Jan 6, 2023

   Contributor

   More actions

   Hi, thanks for surfacing this. I see the update could indeed cause problems in the wrong circumstances - luckily for you, the fix is relatively straightforward!

   First, the Problem: To be able to flush events before the lambda on Vercel or AWS terminates, the SDK needs to wrap res.{send,json,end}() and turn them into async functions. In the example you shared, you're calling res.json() and res.end() sequentially and because these functions are now basically async, their execution order may be reversed (V8 probably decides on the order).

   We should probably introduce a mechanism that preserves the execution order - even though it is generally not advised to call both .json() and .end() for the same request - not just in combination with the Sentry SDK but in general. The fix is therefore simply not doing that. You're already doing that by having a return statement in front of some res.json() calls. You can simply add it to the 200 and 400 response code paths and everything should work again.

   We'll investigate if we can find a solution for this behaviour out of the box but please try out the proposed fix and let me know if it worked!

   👍React with 👍1Reacted by Wade Hammes
5. lforst

   added

   Status: Confirmed

   Package: nextjs

   and removed

   Status: Untriaged

   on Jan 6, 2023
6. wadehammes commented on Jan 6, 2023

   

   wadehammes

   on Jan 6, 2023

   Author

   More actions

   @lforst that is good to know! Ill refactor now and let you know.
7. lforst commented on Jan 6, 2023

   

   lforst

   on Jan 6, 2023

   Contributor

   More actions

   @wadehammes We'll probably release a fix for this on Monday. Thanks again for reporting this! In the meanwhile, the workaround I described should still work. (PR if you're interested #6674)

   ❤️React with ❤️1Reacted by Wade Hammes
8. lforst

   self-assigned this

   on Jan 6, 2023
9. wadehammes commented on Jan 6, 2023

   

   wadehammes

   on Jan 6, 2023

   Author

   More actions

   @wadehammes We'll probably release a fix for this on Monday. Thanks again for reporting this! In the meanwhile, the workaround I described should still work. (PR if you're interested #6674)

   awesome. that fix worked and is a lot more straightforward. thank you
10. lforst

    closed this as completedin #6674on Jan 9, 2023
11. lforst commented on Jan 10, 2023

    

    lforst

    on Jan 10, 2023

    Last edited by lforst

    Contributor

    More actions

    We just released a fix with version 7.30.0 of the SDK.