API: Stabilize localAutosave()

WordPress · Feb 10, 2020 · b72de73 · b72de73
1 parent ad44389
commit b72de73
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 21 deletions.
diff --git a/docs/designers-developers/developers/data/data-core-editor.md b/docs/designers-developers/developers/data/data-core-editor.md
@@ -1140,6 +1140,11 @@ _Related_
 
 -   insertDefaultBlock in core/block-editor store.
 
+<a name="localAutosave" href="#localAutosave">#</a> **localAutosave**
+
+Action generator used in signalling that the post should be locally
+autosaved (e.g. on the Web, it might be committed to Session Storage).
+
 <a name="lockPostAutosaving" href="#lockPostAutosaving">#</a> **lockPostAutosaving**
 
 Returns an action object used to signal that post autosaving is locked.

diff --git a/packages/e2e-tests/specs/editor/various/autosave.test.js b/packages/e2e-tests/specs/editor/various/autosave.test.js
@@ -111,9 +111,7 @@ describe( 'autosave', () => {
 
 		// Trigger local autosave
 		await page.evaluate( () =>
-			window.wp.data
-				.dispatch( 'core/editor' )
-				.__experimentalLocalAutosave()
+			window.wp.data.dispatch( 'core/editor' ).localAutosave()
 		);
 		// Reload without saving on the server
 		await page.reload();
@@ -213,9 +211,7 @@ describe( 'autosave', () => {
 
 		// Trigger local autosave
 		await page.evaluate( () =>
-			window.wp.data
-				.dispatch( 'core/editor' )
-				.__experimentalLocalAutosave()
+			window.wp.data.dispatch( 'core/editor' ).localAutosave()
 		);
 		expect(
 			await page.evaluate( () => window.sessionStorage.length )
@@ -239,9 +235,7 @@ describe( 'autosave', () => {
 
 		// Trigger local autosave
 		await page.evaluate( () =>
-			window.wp.data
-				.dispatch( 'core/editor' )
-				.__experimentalLocalAutosave()
+			window.wp.data.dispatch( 'core/editor' ).localAutosave()
 		);
 		expect(
 			await page.evaluate( () => window.sessionStorage.length )
@@ -266,9 +260,7 @@ describe( 'autosave', () => {
 
 		// Trigger local autosave
 		await page.evaluate( () =>
-			window.wp.data
-				.dispatch( 'core/editor' )
-				.__experimentalLocalAutosave()
+			window.wp.data.dispatch( 'core/editor' ).localAutosave()
 		);
 		expect(
 			await page.evaluate( () => window.sessionStorage.length )
@@ -289,9 +281,7 @@ describe( 'autosave', () => {
 
 		// Trigger local autosave
 		await page.evaluate( () =>
-			window.wp.data
-				.dispatch( 'core/editor' )
-				.__experimentalLocalAutosave()
+			window.wp.data.dispatch( 'core/editor' ).localAutosave()
 		);
 		expect(
 			await page.evaluate( () => window.sessionStorage.length )
@@ -320,9 +310,7 @@ describe( 'autosave', () => {
 
 		// Force conflicting local autosave
 		await page.evaluate( () =>
-			window.wp.data
-				.dispatch( 'core/editor' )
-				.__experimentalLocalAutosave()
+			window.wp.data.dispatch( 'core/editor' ).localAutosave()
 		);
 		expect(
 			await page.evaluate( () => window.sessionStorage.length )

diff --git a/packages/editor/src/components/local-autosave-monitor/index.js b/packages/editor/src/components/local-autosave-monitor/index.js
@@ -147,9 +147,9 @@ function useAutosavePurge() {
 }
 
 function LocalAutosaveMonitor() {
-	const { __experimentalLocalAutosave } = useDispatch( 'core/editor' );
+	const { localAutosave } = useDispatch( 'core/editor' );
 	const autosave = useCallback( () => {
-		requestIdleCallback( __experimentalLocalAutosave );
+		requestIdleCallback( localAutosave );
 	}, [] );
 	useAutosaveNotice();
 	useAutosavePurge();

diff --git a/packages/editor/src/store/actions.js b/packages/editor/src/store/actions.js
@@ -345,7 +345,11 @@ export function* autosave( options ) {
 	yield dispatch( STORE_KEY, 'savePost', { isAutosave: true, ...options } );
 }
 
-export function* __experimentalLocalAutosave() {
+/**
+ * Action generator used in signalling that the post should be locally
+ * autosaved (e.g. on the Web, it might be committed to Session Storage).
+ */
+export function* localAutosave() {
 	const post = yield select( STORE_KEY, 'getCurrentPost' );
 	const title = yield select( STORE_KEY, 'getEditedPostAttribute', 'title' );
 	const content = yield select(