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.

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

CustomField - Increase maxLength for Link fields to 2047 characters. #31868

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

colemanw
Copy link
Member

@colemanw colemanw commented Jan 23, 2025

Overview

Increase size of custom Link fields to handle very long links.
See https://civicrm.stackexchange.com/questions/49123/how-can-i-store-longer-urls

Also fixes a bug triggered by adding an index to very long varchar fields.

Before

Limit for Link custom fields 255 characters, which was arbitrarily small.

After

Bumped maxLength to 2047, reflecting sitemap URL limits.
Existing fields will not be affected immediately, but editing and re-saving them will update the maxlength.

Comments

While testing the above, a bug surfaced:

  1. Create a custom field with maxlength > 2000 and check the Optimize for Search option.
  2. The result is a fatal error.

I'm kinda surprised that this is the first time anyone noticed that bug, but the problem is that mySql has a limit to how long an index can be. Fixed the error by constraining the length of the index, and added test coverage.

Copy link

civibot bot commented Jan 23, 2025

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers...

➡️ Online demo of this PR 🔗

@chumkui
Copy link

chumkui commented Jan 24, 2025

I have applied the changes and all works as expected. I also removed and readded the fields back to the webform and it now takes the longer URLs. I can see in the database that the fields are VARCHAR(2047) now so all seems good to me. I can see the 4 failures, but it is working as expected for me on Drupal 10.4.1, CiviCRM 5.81, PHP8.1.31

Updated `fieldToSQLType` to handle Link fields with a default maxLength of 2047, reflecting sitemap URL limits. Adjusted tests to validate handling of Link fields.
Before: create a custom field with maxlength > 2000
and check the Optimize for Search option.
The result is a fatal error.

After: Field is created without issue.
@colemanw colemanw added the merge ready PR will be merged after a few days if there are no objections label Jan 24, 2025
@colemanw
Copy link
Member Author

colemanw commented Jan 24, 2025

Thanks @chumkui I've given this merge ready based on your review.

I've fixed the test failures. A couple of them were caused by hitting the limit for table size, e.g. if you create a custom group with a bunch of fields and they are all varchar(2047) you can exceed the limit for combined total of all columns.

For that reason I've reduced the scope of this PR to only set the default for LInk fields and not other types of text fields.
You probably don't need to worry about re-patching your site since creating custom text fields in the UI lets you set the size yourself and the default doesn't really matter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
master merge ready PR will be merged after a few days if there are no objections
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants