Pypi package upload errors due to violation of length check constraints

💥 Problem Summary

When we introduced new Pypi metadata fields with check constraints on the field lengths, we started encountering Pypi package upload errors when the package to be uploaded violates the check constraints.

See:

• #431505 (closed)
• #440402 (closed)

🚑 Solution

We don't want to remove the check constraints, as those prevent unbounded resource consumption of Package Registry.

We can follow the approach we did with the description field (!137000 (merged)) and the keywords field (!144983 (merged)): truncate the text if it is too long, and then upload the truncated text.

To prevent further errors, we should consider applying this approach on the other metadata fields that have check constraints:

• summary (255 chars)
• author_email (2048 chars)
• required_python (255 chars)
• metadata_version (16 chars)
• description_content_type (128 chars)

Steps to reproduce

Build and attempt to upload a PyPI package with a summary longer than 255 chars.

What is the current bug behavior?

Uploading a package with a summary field (populated from description on pyproject.toml) results in an error:

INFO     Response from http://gdk.test:3000/api/v4/projects/7/packages/pypi:                                                                                                                                
         400 Bad Request                                                                                                                                                                                    
INFO     {"message":"400 Bad request - Validation failed: Summary is too long (maximum is 255 characters)"}                                                                                                 
ERROR    HTTPError: 400 Bad Request from http://gdk.test:3000/api/v4/projects/7/packages/pypi                                                                                                               
         Bad Request   

The package was not uploaded.

What is the expected correct behavior?

The package should upload without error.

added typebug label

set weight to 1

assigned to @radbatnag

marked this issue as related to #440402 (closed)

changed weight to 2 from 1

Giving this a weight of 2️⃣ because we'll try for a more generic approach to handle all the text field constraints, to close these errors for good.

👋 @radbatnag, Please add a group or category label to identify issue ownership.

You can refer to the Features by Group handbook page for guidance.

If you are unsure about the correct group, please do not leave the issue without a group label, and refer to GitLab's shared responsibility functionality guidelines for more information on how to triage this kind of issue.

This message was generated automatically. You're welcome to improve it.

mentioned in issue #440402 (closed)

added PyPI Repository devopspackage workflowready for development labels

added sectionci label

added severity3 label

added priority3 label and removed severity3 label

added severity3 label

This issue was automatically tagged with the label grouppackage registry by TanukiStan, a machine learning classification model, with a probability of 1.

If this label is incorrect, please tag this issue with the correct group label as well as automation:ml wrong to help TanukiStan learn from its mistakes.

If you are unsure about the correct group, please do not leave the issue without a group label. Please refer to GitLab's shared responsibility functionality guidelines for more information on how to triage this kind of issues.

Authors who do not have permission to update labels can use the @gitlab-bot label ~"group::<correct group name>" command, or leave the issue to be triaged by group leaders initially assigned by TanukiStan.

This message was generated automatically. You're welcome to improve it.

added automation:ml grouppackage registry labels

mentioned in issue gitlab-org/quality/triage-reports#16728 (closed)

mentioned in issue gitlab-org/quality/triage-reports#16810 (closed)

added Category:Package Registry label

Hi @radbatnag are there any plans to solve this issue in the next releases? If not I will have to look for a workaround for some of our python related projects.

created branch 444304-pypi-package-upload-errors-due-to-violation-of-length-check-constraints to address this issue

mentioned in merge request !147891 (merged)

changed milestone to %17.0

added Package:P1 label

mentioned in issue #451600 (closed)

added workflowproduction label and removed workflowready for development label

changed milestone to %17.1

added missed:17.0 label

added workflowcomplete label and removed workflowproduction label

closed