search

stripe / stripe-apps

Stripe Apps lets you embed custom user experiences directly in the Stripe Dashboard and orchestrate the Stripe API.
https://stripe.com/docs/stripe-apps
MIT License
148 stars 73 forks source link

Intermittent issue: alignX: "undefined" kills app in version 9.0.0-alpha.15 #990

Closed bensontrent closed 2 weeks ago

bensontrent commented 1 month ago

As a developer, I know intermittent, non-consistent issues that can be solved by a refresh are of the worst kind to troubleshoot. I'm seeing this issue with version 9.0.0-alpha.15 of the @stripe/ui-extension-sdk about 80% of the time.

I see this error in version 9 (an error I don't see in version 8):

image

image

I don't have any empty elements or instances of any attribute of alignX: undefined. I'm posting this as a placeholder to add a ticket to this issue, as I understand I'm working with a beta version...so I don't expect a response to this. The frustrating thing about this bug is that it is intermittent. A browser refresh will solve the issue in 20% of refresh cases. I'm still trying to isolate the problem in my code that creates this issue...so this might be a "my" issue report. But I'm posting this to see if there is an easily solvable resolution to this bug. I'm happy to share my source code privately with any interested party.

I understand I'm working with a beta version, and this issue can be solved by simply using version 8. But I'm just flagging this as an issue in the beta version.

matebek-stripe commented 1 month ago

Hi @bensontrent, thank you for reporting this issue. The behavior you're experiencing is indeed unexpected. As mentioned in our SDK upgrade guide, we have been enforcing property validation during development since v9 of @stripe/ui-extension-sdk.

To better understand and address your issue, it would be helpful if you could provide a code example that reproduces the problem in isolation. When an invalid prop is encountered, you should see the source of the issue, as shown in the following screenshot:

image

However, the error you're seeing appears to be different from what we typically expect from our SDK's property validation. We need to investigate further to understand how this is occurring in your case.

bensontrent commented 1 month ago

Based on your feedback on how the error should appear, I haven't confirmed this, but it seems to be an issue when using <></> empty React container elements such as <><SomeOtherComponent /></>. I'll do some more tests to confirm.

bensontrent commented 1 month ago

@matebek-stripe I've given you private access to the Parcelcraft app at https://github.com/parcelcraft/parcelcraft-app

This is also exhibiting a new intermittent error on our Main Dashboard view:

image

I've confirmed this bug appears in version 9.0.0-alpha.15. The issue does not appear in 8.9.1. I'm no closer to identifying the issue, but it appears to be an issue with the app loader itself, (I've added an ErrorBoundry to my code to catch errors).

matebek-stripe commented 3 weeks ago

@bensontrent Thanks! Our team will take a look at it this week and let you know if we have any updates on the issue.

bensontrent commented 3 weeks ago

A private install link might be better for you than my full code, though it should provide a good reference. (My EasyPost npm package has been privately customized; I'll work on publishing my fork.) You can request an install link from me at benson@parcelcraft.com. Cheers!

Update: I have fixed the Types in my private repo.

aaronhernandez-stripe commented 3 weeks ago

Hello @bensontrent I took a look at the code you shared and it looks good, I tried to reproduce the issue In the Stripe dashboard using your app but I was unable to see the same issue you are experiencing. The only thing that stood out is that you are installing react@^18.3.1 while the only version of react we currently support is react@17.0.2 (https://docs.stripe.com/stripe-apps/how-ui-extensions-work#apps-cant-control-the-react-version), while I don't think this would cause the error I recommend to downgrade to that version and see if the error is still present.

Could you share more details about your test setup so I can try to mimic it as close as possible:

Any other information that could help us reproduce/debug the issue is welcome, Thanks!

bensontrent commented 3 weeks ago

Hi @aaronhernandez-stripe!

Are you seeing this error only when developing, on a published app or both?

What browser and version are you using?

What version of the stripe apps cli are you using stripe apps -v?

image

are you using yarn or npm to install dependencies?

More tips to reproduce the error:

bensontrent commented 2 weeks ago

@matebek-stripe I see you've scheduled a meeting with me for tomorrow. I'll see you there.

New findings:

matebek-stripe commented 2 weeks ago

@bensontrent We have just deployed a fix, could you please test it on your end to see if the error is indeed resolved?

bensontrent commented 2 weeks ago

@matebek-stripe The settings view is indeed fixed. I still have an issue with the main dashboard view:

image

image

matebek-stripe commented 2 weeks ago

A change has been rolled out to fix all the reported errors. Closing this issue now. Thank you @bensontrent for bringing this to our attention!