-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Moves font directory into uploads to match WP 6.5 #60354
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
261c04f
Updates default font directory location
creativecoder 8b48c22
Deletes font files from legacy folder location
creativecoder e0423c2
Adds tests for deleting fonts in the previous folder location
creativecoder 70464cb
Format PHP
creativecoder abbbb28
Adds and updates docblocks for tests
creativecoder File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
194 changes: 194 additions & 0 deletions
194
phpunit/tests/fonts/font-library/fontDeleteFilesFromWpContentFolder.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,194 @@ | ||
<?php | ||
// @core-merge: Do not include these tests, they are for Gutenberg only. | ||
|
||
/** | ||
* Tests deleting font files from the previous fonts folder default (wp-content/fonts). | ||
* | ||
* This covers cases where fonts were installed with older versions of Gutenberg, but are then deleted with | ||
* newer versions of Gutenberg and/or WordPress. | ||
* | ||
* @package WordPress | ||
* @subpackage Font Library | ||
* | ||
* @group fonts | ||
* @group font-library | ||
*/ | ||
class Tests_Font_Delete_Files_From_Wp_Content_Folder extends WP_UnitTestCase { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are you able to add docblocks for the methods and properties throughout? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍🏼 done in abbbb28 |
||
/** | ||
* ID of a super admin user. | ||
* | ||
* @var int | ||
*/ | ||
protected static $super_admin_id; | ||
|
||
/** | ||
* Sets up test class. | ||
* | ||
* @param WP_UnitTest_Factory $factory Unit test factory instance. | ||
*/ | ||
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) { | ||
self::$super_admin_id = $factory->user->create( | ||
array( | ||
'role' => 'administrator', | ||
) | ||
); | ||
grant_super_admin( self::$super_admin_id ); | ||
} | ||
|
||
/** | ||
* Tears down test class. | ||
*/ | ||
public static function wpTearDownAfterClass() { | ||
self::delete_user( self::$super_admin_id ); | ||
} | ||
|
||
/** | ||
* Tests that font files uploaded to wp-content/fonts are deleted when the associated font face post is deleted. | ||
* | ||
* @covers ::gutenberg_before_delete_font_face | ||
*/ | ||
public function test_uploaded_font_files_are_deleted_from_wp_content_fonts_folder() { | ||
wp_set_current_user( self::$super_admin_id ); | ||
$font_family_id = $this->create_font_family(); | ||
|
||
// Upload the font file to wp-content/fonts, the previous directory used for fonts. | ||
add_filter( 'font_dir', array( $this, 'filter_font_dir' ) ); | ||
$response = $this->create_font_face( $font_family_id ); | ||
remove_filter( 'font_dir', array( $this, 'filter_font_dir' ) ); | ||
|
||
$this->assertSame( 201, $response->get_status(), 'The font face should be created successfully.' ); | ||
|
||
$data = $response->get_data(); | ||
$font_path = str_replace( content_url(), WP_CONTENT_DIR, $data['font_face_settings']['src'] ); | ||
|
||
// Ensure the file was uploaded to the correct location. | ||
$this->assertFalse( str_contains( $font_path, 'uploads' ), 'The font file should not be in the uploads folder.' ); | ||
$this->assertTrue( file_exists( $font_path ), 'The font file should exist in the wp-content/fonts folder.' ); | ||
|
||
// Ensure the file is deleted when the font face post is deleted, even when the directory is not filtered. | ||
wp_delete_post( $font_family_id, true ); | ||
$this->assertTrue( str_contains( wp_get_font_dir()['path'], 'uploads' ), 'The font directory should be in uploads.' ); | ||
$this->assertFalse( file_exists( $font_path ), 'The font file should be deleted from the wp-content/fonts folder.' ); | ||
} | ||
|
||
/** | ||
* Tests that font files uploaded to wp-content/fonts are deleted when the associated font face post is deleted on multisite. | ||
* | ||
* @group multisite | ||
* @group ms-required | ||
* | ||
* @covers ::gutenberg_before_delete_font_face | ||
*/ | ||
public function test_uploaded_font_files_are_deleted_from_wp_content_fonts_folder_multisite() { | ||
wp_set_current_user( self::$super_admin_id ); | ||
$blog_id = self::factory()->blog->create(); | ||
|
||
switch_to_blog( $blog_id ); | ||
$font_family_id = $this->create_font_family(); | ||
|
||
// Upload the font file to wp-content/fonts, the previous directory used for fonts. | ||
add_filter( 'font_dir', array( $this, 'filter_font_dir' ) ); | ||
$response = $this->create_font_face( $font_family_id ); | ||
remove_filter( 'font_dir', array( $this, 'filter_font_dir' ) ); | ||
restore_current_blog(); | ||
|
||
$this->assertSame( 201, $response->get_status(), 'The font face should be created successfully.' ); | ||
|
||
$data = $response->get_data(); | ||
$font_path = str_replace( content_url(), WP_CONTENT_DIR, $data['font_face_settings']['src'] ); | ||
|
||
// Ensure the file was uploaded to the correct location. | ||
$this->assertFalse( str_contains( $font_path, 'uploads' ), 'The font file should not be in the uploads folder.' ); | ||
$this->assertTrue( file_exists( $font_path ), 'The font file should exist in the wp-content/fonts folder.' ); | ||
|
||
// Ensure the file is deleted when the font face post is deleted, even when the directory is not filtered. | ||
switch_to_blog( $blog_id ); | ||
wp_delete_post( $font_family_id, true ); | ||
restore_current_blog(); | ||
|
||
$this->assertTrue( str_contains( wp_get_font_dir()['path'], 'uploads' ), 'The font directory should be in uploads.' ); | ||
$this->assertFalse( file_exists( $font_path ), 'The font file should be deleted from the wp-content/fonts folder.' ); | ||
} | ||
|
||
/** | ||
* Sets the font upload directory to wp-content/fonts, the default previously used in Gutenberg. | ||
* | ||
* @param array $font_dir Font directory settings. | ||
* @return array Filtered font directory settings. | ||
*/ | ||
public function filter_font_dir( $font_dir ) { | ||
$site_path = ''; | ||
if ( is_multisite() && ! ( is_main_network() && is_main_site() ) ) { | ||
$site_path = '/sites/' . get_current_blog_id(); | ||
} | ||
|
||
$font_dir['path'] = path_join( WP_CONTENT_DIR, 'fonts' ) . $site_path; | ||
$font_dir['url'] = untrailingslashit( content_url( 'fonts' ) ) . $site_path; | ||
$font_dir['basedir'] = path_join( WP_CONTENT_DIR, 'fonts' ) . $site_path; | ||
$font_dir['baseurl'] = untrailingslashit( content_url( 'fonts' ) ) . $site_path; | ||
|
||
return $font_dir; | ||
} | ||
|
||
/** | ||
* Creates a font family post for testing. | ||
* | ||
* @return int Font family post ID. | ||
*/ | ||
protected function create_font_family() { | ||
return self::factory()->post->create( | ||
wp_slash( | ||
array( | ||
'post_type' => 'wp_font_family', | ||
'post_status' => 'publish', | ||
'post_title' => 'Open Sans', | ||
'post_name' => 'open-sans', | ||
'post_content' => wp_json_encode( | ||
array( | ||
'fontFamily' => '"Open Sans"', | ||
) | ||
), | ||
) | ||
) | ||
); | ||
} | ||
|
||
/** | ||
* Creates a font face post under the specified font family for testing. | ||
* | ||
* @param int $font_family_id Font family post ID. | ||
* @return WP_REST_Response REST response object for font face creation. | ||
*/ | ||
protected function create_font_face( $font_family_id ) { | ||
// Create a new font face with a font file upload. | ||
$font_file = GUTENBERG_DIR_TESTDATA . '/fonts/OpenSans-Regular.woff2'; | ||
$font_path = wp_tempnam( 'OpenSans-Regular.woff2' ); | ||
copy( $font_file, $font_path ); | ||
|
||
$files = array( | ||
'file-0' => array( | ||
'name' => 'OpenSans-Regular.woff2', | ||
'full_path' => 'OpenSans-Regular.woff2', | ||
'type' => 'font/woff2', | ||
'tmp_name' => $font_path, | ||
'error' => 0, | ||
'size' => filesize( $font_path ), | ||
), | ||
); | ||
|
||
$request = new WP_REST_Request( 'POST', '/wp/v2/font-families/' . $font_family_id . '/font-faces' ); | ||
$request->set_param( | ||
'font_face_settings', | ||
wp_json_encode( | ||
array( | ||
'fontFamily' => '"Open Sans"', | ||
'fontWeight' => '200', | ||
'fontStyle' => 'normal', | ||
'src' => 'file-0', | ||
) | ||
) | ||
); | ||
$request->set_file_params( $files ); | ||
return rest_get_server()->dispatch( $request ); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch, I would have totally missed this.