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

Jump to bottom

docs: Add troubleshooting steps for CRA and Geo components #2511

Merged
merged 2 commits into from
Aug 24, 2022
Merged

docs: Add troubleshooting steps for CRA and Geo components #2511

merged 2 commits into from
Aug 24, 2022

Conversation

slaymance
Copy link
Contributor

@slaymance slaymance commented Aug 24, 2022 •
edited
Loading

Description of changes

Applications that are built with Create React App v5 and that are using Geo components may face the following error when attempting to render the <MapView> component in a production build:

Uncaught ReferenceError: g is not defined

This is related to this maplibre-gl issue and stems from the dropping of support for Internet Explorer in maplibre-gl v2. This pull request adds troubleshooting guidelines to our documentation to help users correct this problem in their applications.

Issue #, if available

#2509

Description of how you validated changes

  1. Make a Create React App using the <MapView> component.
  2. Do a production build using npx run build.
  3. Start the production build application using serve (serve -s build) and verify that <MapView> renders without error.

Checklist

  • PR description included
  • yarn test passes
  • Relevant documentation is changed or added (and PR referenced)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@changeset-bot
Copy link

changeset-bot bot commented Aug 24, 2022 •
edited
Loading

⚠️ No Changeset found

Latest commit: 5398689

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@slaymance slaymance self-assigned this Aug 24, 2022
@slaymance slaymance added the Documentation An issue or a feature-request for our Amplify UI Doc site or AWS Amplify docs label Aug 24, 2022
@slaymance slaymance marked this pull request as ready for review August 24, 2022 21:19
@slaymance slaymance requested a review from a team as a code owner August 24, 2022 21:19
thaddmt
thaddmt approved these changes Aug 24, 2022
View reviewed changes
Copy link
Member

@thaddmt thaddmt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@slaymance slaymance temporarily deployed to ci August 24, 2022 21:38 Inactive
@slaymance slaymance temporarily deployed to ci August 24, 2022 21:38 Inactive
@slaymance slaymance temporarily deployed to ci August 24, 2022 21:38 Inactive
@slaymance slaymance temporarily deployed to ci August 24, 2022 21:38 Inactive
ErikCH
ErikCH approved these changes Aug 24, 2022
View reviewed changes
Copy link
Contributor

@ErikCH ErikCH left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this!

@slaymance slaymance merged commit d28ac1f into main Aug 24, 2022
@slaymance slaymance deleted the cra-troubleshooting branch August 24, 2022 22:31
calebpollman added a commit that referenced this pull request Aug 25, 2022
@calebpollman @joebuono
@thaddmt @hbuchel @github-actions @0618 @wlee221 @slaymance @jacoblogan
chore(in-app-messaging): merge main in to in-app-messaging/main from …
cffdf7f 
…latest release commit (#2485)

* chore: Update yarn.lock (#2440)

* update yarn.lock

* updated yarn.lock to include geocoder update

Co-authored-by: Joe Buono <[email protected]>

* Fix location search bug (#2450)

* fix: update maplibre-gl-js-amplify to v2.0.3 to fix location search bug

* fix: update to maplibre-gl-js-amplify v2.0.4

* fix: pin maplibre-gl-js-amplify version

* Create hip-horses-arrive.md

* fix(react): hide svg icon images in a11y tree in Rating component (#2469)

* fix(react): hide svg icon images in a11y tree in Rating component

* Version Packages (#2461)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* fix(docs): type error on fragment (#2477)

Co-authored-by: 0618 <[email protected]>

* add @types/react to resolutions field

* chore(ui): Set `predictableActionArguments` to true (#2468)

* Set `predictableActionArguments` to true

* Create clean-suns-fix.md

* Add predictableActionArguments to `true`

* Delete the auth-with-username environment (#2489)

* Revert "chore(ui): Set `predictableActionArguments` to true (#2468)" (#2492)

This reverts commit 665c426.

* fix(ci): Change e2e environments to auth-with-username-no-attributes (#2491)

* Change e2e environments to auth-with-username-no-attributes

* Remove additional attribute from sign-up test

Co-authored-by: William Lee <[email protected]>

* chore: remove stale chmod line in package.json (#2497)

* Remove chmod in package.json

* remove chmod in canary as well

* [REVERT] poc run without chmod

* [REVERT]: add missing environement

* [REVERT]: Add amplify cli

* trigger-ci

* [REVERT]: Remove unneeded codes in POC workflow

* use yarn environments pull instead of yarn pull

* Why doesn't this work?

* This should work!

* Remove duplciate shell call

* Remove poc workflow

* chore(hosting): Skip cypress binary installation (#2508)

* chore(environments): move environments to their own folder (#2501)

* Split environments into respective folders

* chore(environments): Update scripts for environments split (#2502)

* Initial approach

* Simpler solution

* Add auth/geo/datastore scripts

* Add general pull command

* Explicitly get path to the shell file

* fix typo

* chore(environments): update `awsExports` to point to new paths (#2504)

* Update react aws-exports

* Vue aws-exports update

* Angular aws-exports updates

* Dial code (#2459)

* rename countryCode to dialCode

* begin deprecating countryCode by adding in duplicate dialCode props and updating all examples to use dialCode props

* update props table

* duplicate phone number field tests using dialCode

* update tests

* add required field to phoneNumberFieldProps, added deprecation warning

* update e2e tests

* update phone number field documentation

* rename countrycode files to dialcode

* update angular and vue dial code select name

* update angular and vue to dial code

* return default label to country code and undo e2e test changes

* update unit tests

* update e2e tests to revert change to dial code

* Create swift-kids-help.md

* Update docs/src/pages/[platform]/components/phonenumberfield/react.mdx

add `role="none"` to docs alert

Co-authored-by: Heather Buchel <[email protected]>

* Update swift-kids-help.md

Co-authored-by: Jacob Logan <[email protected]>
Co-authored-by: Heather Buchel <[email protected]>

* Add troubleshooting steps for CRA and geo components (#2511)

* fix(environments): fix environments pull on CI (#2512)

* POC run against guides

* Try bash instead of sh

* Add debug line

* Use printf instead of echo

* Add more comments

* Update import path in guides

* Adjust comments

* Adjust comment

* Remove extraneous comments

* More comments adjustment

* Revert "POC run against guides"

This reverts commit 88bceca.

* update changeset (#2515)

Co-authored-by: Jacob Logan <[email protected]>

Co-authored-by: Joe Buono <[email protected]>
Co-authored-by: Joe Buono <[email protected]>
Co-authored-by: thaddmt <[email protected]>
Co-authored-by: Heather Buchel <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: MJ <[email protected]>
Co-authored-by: 0618 <[email protected]>
Co-authored-by: William Lee <[email protected]>
Co-authored-by: Shane Laymance <[email protected]>
Co-authored-by: jacoblogan <[email protected]>
Co-authored-by: Jacob Logan <[email protected]>
calebpollman pushed a commit to calebpollman/amplify-ui that referenced this pull request Aug 25, 2022
@slaymance @calebpollman
Add troubleshooting steps for CRA and geo components (aws-amplify#2511)
d840b22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ioanabrooks ioanabrooks ioanabrooks approved these changes

@thaddmt thaddmt thaddmt approved these changes

@ErikCH ErikCH ErikCH approved these changes

Assignees

@slaymance slaymance

Labels
Documentation An issue or a feature-request for our Amplify UI Doc site or AWS Amplify docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@slaymance @ErikCH @thaddmt @ioanabrooks