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

Site Editor: Display a notice if export fails #37131

Merged
merged 1 commit into from
Dec 7, 2021
Merged

Site Editor: Display a notice if export fails #37131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 2 additions & 32 deletions packages/edit-site/src/plugins/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,51 +1,21 @@
/**
* External dependencies
*/
import downloadjs from 'downloadjs';

/**
* WordPress dependencies
*/
import { MenuItem } from '@wordpress/components';
import { __ } from '@wordpress/i18n';
import { registerPlugin } from '@wordpress/plugins';
import apiFetch from '@wordpress/api-fetch';
import { download } from '@wordpress/icons';

/**
* Internal dependencies
*/
import ToolsMoreMenuGroup from '../components/header/tools-more-menu-group';
import SiteExport from './site-export';
import WelcomeGuideMenuItem from './welcome-guide-menu-item';

registerPlugin( 'edit-site', {
render() {
return (
<>
<ToolsMoreMenuGroup>
<MenuItem
role="menuitem"
icon={ download }
onClick={ () =>
apiFetch( {
path: '/wp-block-editor/v1/export',
parse: false,
} )
.then( ( res ) => res.blob() )
.then( ( blob ) =>
downloadjs(
blob,
'edit-site-export.zip',
'application/zip'
)
)
}
info={ __(
'Download your templates and template parts.'
) }
>
{ __( 'Export' ) }
</MenuItem>
<SiteExport />
<WelcomeGuideMenuItem />
</ToolsMoreMenuGroup>
</>
Expand Down
48 changes: 48 additions & 0 deletions packages/edit-site/src/plugins/site-export.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/**
* External dependencies
*/
import downloadjs from 'downloadjs';

/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { MenuItem } from '@wordpress/components';
import apiFetch from '@wordpress/api-fetch';
import { download } from '@wordpress/icons';
import { useDispatch } from '@wordpress/data';
import { store as noticesStore } from '@wordpress/notices';

export default function SiteExport() {
const { createErrorNotice } = useDispatch( noticesStore );

async function handleExport() {
try {
const response = await apiFetch( {
path: '/wp-block-editor/v1/export',
parse: false,
} );
const blob = await response.blob();

downloadjs( blob, 'edit-site-export.zip', 'application/zip' );
} catch ( error ) {
const errorMessage =
error.message && error.code !== 'unknown_error'
Copy link
Member

Choose a reason for hiding this comment

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

There are mutiple error code that could be returned here.

  • rest_cannot_export_templates - permission error.
  • missing_zip_package - Unable to generate ZIP because of missing package.
  • unable_to_create_zip - Unable to generate ZIP for unknown reasons.

Should there be different error messages here.

See WordPress/wordpress-develop#2008

Copy link
Member Author

Choose a reason for hiding this comment

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

@spacedmonkey, this is for default error message if the code is unknown. Otherwise, it will use messages returned from the server.

? error.message
: __( 'An error occurred while creating the site export.' );

createErrorNotice( errorMessage, { type: 'snackbar' } );
}
}

return (
<MenuItem
role="menuitem"
icon={ download }
onClick={ handleExport }
info={ __( 'Download your templates and template parts.' ) }
>
{ __( 'Export' ) }
</MenuItem>
);
}