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

Font Library: Add sanitize from schema util #58571

Merged
merged 14 commits into from
Feb 2, 2024

Conversation

matiasbenedetto
Copy link
Contributor

@matiasbenedetto matiasbenedetto commented Feb 1, 2024

What?

Add ssanitize_from_schema util function.
This function sanitizes the data schema and applies a sanitizer function to the values.

Read the unit tests added in this PR to see several examples of sanitization of different data types.

Why?

We need a function to sanitize nested data, remove unwanted data properties, and apply a sanitizer function to the values.

How?

By implementing the sanitize_from_schema function.

Testing Instructions

  • Run unit tests

Copy link

github-actions bot commented Feb 1, 2024

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files
❔ phpunit/tests/fonts/font-library/wpFontUtils/sanitizeFromSchema.php
❔ lib/compat/wordpress-6.5/fonts/class-wp-font-utils.php

Copy link
Contributor

@creativecoder creativecoder left a comment

Choose a reason for hiding this comment

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

Left some initial code comments, this is looking good.

I've been watching the work in #58502 that addresses small issues in the existing font library tests. It seems best if we get those in here from the start so additional cleanup isn't needed later.

Copy link

github-actions bot commented Feb 1, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core SVN

If you're a Core Committer, use this list when committing to wordpress-develop in SVN:

Props: mmaattiiaass, grantmkin.

GitHub Merge commits

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: matiasbenedetto <mmaattiiaass@git.wordpress.org>
Co-authored-by: creativecoder <grantmkin@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Contributor

@creativecoder creativecoder left a comment

Choose a reason for hiding this comment

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

This looks good and works as expected in my testing some basic sanitization. The unit tests also do a nice job of showing how usage works.

I think this implementation is very similar to how theme.json is sanitized. At some point we should look into how the functionality could be shared. But until then, having this private access utility function works well.

@matiasbenedetto matiasbenedetto merged commit 05d5475 into trunk Feb 2, 2024
58 of 59 checks passed
@matiasbenedetto matiasbenedetto deleted the add/sanitize-from-schema branch February 2, 2024 18:32
anton-vlasenko

This comment was marked as outdated.

@github-actions github-actions bot added this to the Gutenberg 17.7 milestone Feb 2, 2024
@matiasbenedetto
Copy link
Contributor Author

matiasbenedetto commented Feb 2, 2024

@anton-vlasenko, thank you so much for the review. I merged the PR just a few seconds before seeing it. I'll incorporate the changes you suggested in another PR regarding sanitization.

@anton-vlasenko
Copy link
Contributor

Thank you, @matiasbenedetto!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants