Framework: Deprecate uid in favor of clientId (#7990)

WordPress · Jul 17, 2018 · 73c24d8 · 73c24d8
1 parent 0b7259e
commit 73c24d8
Show file tree

Hide file tree

Showing 157 changed files with 2,104 additions and 1,658 deletions.
diff --git a/blocks/api/factory.js b/blocks/api/factory.js
@@ -52,10 +52,14 @@ export function createBlock( name, blockAttributes = {}, innerBlocks = [] ) {
 		return result;
 	}, {} );
 
-	// Blocks are stored with a unique ID, the assigned type name,
-	// the block attributes, and their inner blocks.
+	const clientId = uuid();
+
+	// Blocks are stored with a unique ID, the assigned type name, the block
+	// attributes, and their inner blocks.
 	return {
-		uid: uuid(),
+		clientId,
+		// TODO: Remove from block interface in 3.5 "UID" deprecation.
+		uid: clientId,
 		name,
 		isValid: true,
 		attributes,
@@ -74,8 +78,12 @@ export function createBlock( name, blockAttributes = {}, innerBlocks = [] ) {
  * @return {Object} A cloned block.
  */
 export function cloneBlock( block, mergeAttributes = {}, newInnerBlocks ) {
+	const clientId = uuid();
+
 	return {
 		...block,
+		clientId,
+		// TODO: Remove from block interface in 3.5 "UID" deprecation.
 		uid: uuid(),
 		attributes: {
 			...block.attributes,
@@ -365,8 +373,8 @@ export function switchToBlockType( blocks, name ) {
 		const transformedBlock = {
 			...result,
 			// The first transformed block whose type matches the "destination"
-			// type gets to keep the existing UID of the first block.
-			uid: index === firstSwitchedBlock ? firstBlock.uid : result.uid,
+			// type gets to keep the existing client ID of the first block.
+			clientId: index === firstSwitchedBlock ? firstBlock.clientId : result.clientId,
 		};
 
 		/**

diff --git a/blocks/api/raw-handling/test/shortcode-converter.js b/blocks/api/raw-handling/test/shortcode-converter.js
@@ -28,8 +28,10 @@ describe( 'segmentHTMLToShortcodeBlock', () => {
 		const expectedBlock = createBlock( 'core/shortcode', {
 			text: '[foo bar="apple"]',
 		} );
-		// uuid will always be random.
-		expectedBlock.uid = transformed[ 1 ].uid;
+		// clientId will always be random.
+		expectedBlock.clientId = transformed[ 1 ].clientId;
+		// TODO: Remove in 3.5 "UID" deprecation.
+		expectedBlock.uid = expectedBlock.clientId;
 		expect( transformed[ 1 ] ).toEqual( expectedBlock );
 		expect( transformed[ 2 ] ).toBe( `
 
@@ -45,16 +47,20 @@ describe( 'segmentHTMLToShortcodeBlock', () => {
 		const firstExpectedBlock = createBlock( 'core/shortcode', {
 			text: '[foo one]',
 		} );
-		// uid will always be random.
-		firstExpectedBlock.uid = transformed[ 1 ].uid;
+		// clientId will always be random.
+		firstExpectedBlock.clientId = transformed[ 1 ].clientId;
+		// TODO: Remove in 3.5 "UID" deprecation.
+		firstExpectedBlock.uid = firstExpectedBlock.clientId;
 		expect( transformed[ 1 ] ).toEqual( firstExpectedBlock );
 		expect( transformed[ 2 ] ).toEqual( `</p>
 <p>` );
 		const secondExpectedBlock = createBlock( 'core/shortcode', {
 			text: '[foo two]',
 		} );
-		// uid will always be random.
-		secondExpectedBlock.uid = transformed[ 3 ].uid;
+		// clientId will always be random.
+		secondExpectedBlock.clientId = transformed[ 3 ].clientId;
+		// TODO: Remove in 3.5 "UID" deprecation.
+		secondExpectedBlock.uid = secondExpectedBlock.clientId;
 		expect( transformed[ 3 ] ).toEqual( secondExpectedBlock );
 		expect( transformed[ 4 ] ).toEqual( '</p>' );
 		expect( transformed ).toHaveLength( 5 );
@@ -71,32 +77,40 @@ describe( 'segmentHTMLToShortcodeBlock', () => {
 		const firstExpectedBlock = createBlock( 'core/shortcode', {
 			text: '[foo one]',
 		} );
-		// uid will always be random.
-		firstExpectedBlock.uid = transformed[ 1 ].uid;
+		// clientId will always be random.
+		firstExpectedBlock.clientId = transformed[ 1 ].clientId;
+		// TODO: Remove in 3.5 "UID" deprecation.
+		firstExpectedBlock.uid = firstExpectedBlock.clientId;
 		expect( transformed[ 1 ] ).toEqual( firstExpectedBlock );
 		expect( transformed[ 2 ] ).toEqual( `</p>
 <p>` );
 		const secondExpectedBlock = createBlock( 'core/shortcode', {
 			text: '[foo two]',
 		} );
-		// uid will always be random.
-		secondExpectedBlock.uid = transformed[ 3 ].uid;
+		// clientId will always be random.
+		secondExpectedBlock.clientId = transformed[ 3 ].clientId;
+		// TODO: Remove in 3.5 "UID" deprecation.
+		secondExpectedBlock.uid = secondExpectedBlock.clientId;
 		expect( transformed[ 3 ] ).toEqual( secondExpectedBlock );
 		expect( transformed[ 4 ] ).toEqual( `</p>
 <p>` );
 		const thirdExpectedBlock = createBlock( 'core/shortcode', {
 			text: '[foo three]',
 		} );
-		// uid will always be random.
-		thirdExpectedBlock.uid = transformed[ 5 ].uid;
+		// clientId will always be random.
+		thirdExpectedBlock.clientId = transformed[ 5 ].clientId;
+		// TODO: Remove in 3.5 "UID" deprecation.
+		thirdExpectedBlock.uid = thirdExpectedBlock.clientId;
 		expect( transformed[ 5 ] ).toEqual( thirdExpectedBlock );
 		expect( transformed[ 6 ] ).toEqual( `</p>
 <p>` );
 		const fourthExpectedBlock = createBlock( 'core/shortcode', {
 			text: '[foo four]',
 		} );
-		// uid will always be random.
-		fourthExpectedBlock.uid = transformed[ 7 ].uid;
+		// clientId will always be random.
+		fourthExpectedBlock.clientId = transformed[ 7 ].clientId;
+		// TODO: Remove in 3.5 "UID" deprecation.
+		fourthExpectedBlock.uid = fourthExpectedBlock.clientId;
 		expect( transformed[ 7 ] ).toEqual( fourthExpectedBlock );
 		expect( transformed[ 8 ] ).toEqual( '</p>' );
 		expect( transformed ).toHaveLength( 9 );

diff --git a/blocks/api/test/factory.js b/blocks/api/test/factory.js
@@ -76,7 +76,7 @@ describe( 'block factory', () => {
 			expect( block.isValid ).toBe( true );
 			expect( block.innerBlocks ).toHaveLength( 1 );
 			expect( block.innerBlocks[ 0 ].name ).toBe( 'core/test-block' );
-			expect( typeof block.uid ).toBe( 'string' );
+			expect( typeof block.clientId ).toBe( 'string' );
 		} );
 	} );
 
@@ -114,8 +114,8 @@ describe( 'block factory', () => {
 				isDifferent: true,
 			} );
 			expect( clonedBlock.innerBlocks ).toHaveLength( 1 );
-			expect( typeof clonedBlock.uid ).toBe( 'string' );
-			expect( clonedBlock.uid ).not.toBe( block.uid );
+			expect( typeof clonedBlock.clientId ).toBe( 'string' );
+			expect( clonedBlock.clientId ).not.toBe( block.clientId );
 		} );
 
 		it( 'should replace inner blocks of the existing block', () => {
@@ -181,10 +181,10 @@ describe( 'block factory', () => {
 			const clonedBlock = cloneBlock( block );
 
 			expect( clonedBlock.innerBlocks ).toHaveLength( 2 );
-			expect( clonedBlock.innerBlocks[ 0 ].uid ).not.toBe( block.innerBlocks[ 0 ].uid );
+			expect( clonedBlock.innerBlocks[ 0 ].clientId ).not.toBe( block.innerBlocks[ 0 ].clientId );
 			expect( clonedBlock.innerBlocks[ 0 ].attributes ).not.toBe( block.innerBlocks[ 0 ].attributes );
 			expect( clonedBlock.innerBlocks[ 0 ].attributes ).toEqual( block.innerBlocks[ 0 ].attributes );
-			expect( clonedBlock.innerBlocks[ 1 ].uid ).not.toBe( block.innerBlocks[ 1 ].uid );
+			expect( clonedBlock.innerBlocks[ 1 ].clientId ).not.toBe( block.innerBlocks[ 1 ].clientId );
 			expect( clonedBlock.innerBlocks[ 1 ].attributes ).not.toBe( block.innerBlocks[ 1 ].attributes );
 			expect( clonedBlock.innerBlocks[ 1 ].attributes ).toEqual( block.innerBlocks[ 1 ].attributes );
 		} );
@@ -731,7 +731,7 @@ describe( 'block factory', () => {
 			const transformedBlocks = switchToBlockType( block, 'core/updated-text-block' );
 
 			expect( transformedBlocks ).toHaveLength( 1 );
-			expect( transformedBlocks[ 0 ] ).toHaveProperty( 'uid' );
+			expect( transformedBlocks[ 0 ] ).toHaveProperty( 'clientId' );
 			expect( transformedBlocks[ 0 ].name ).toBe( 'core/updated-text-block' );
 			expect( transformedBlocks[ 0 ].isValid ).toBe( true );
 			expect( transformedBlocks[ 0 ].attributes ).toEqual( {
@@ -770,7 +770,7 @@ describe( 'block factory', () => {
 			const transformedBlocks = switchToBlockType( block, 'core/updated-text-block' );
 
 			expect( transformedBlocks ).toHaveLength( 1 );
-			expect( transformedBlocks[ 0 ] ).toHaveProperty( 'uid' );
+			expect( transformedBlocks[ 0 ] ).toHaveProperty( 'clientId' );
 			expect( transformedBlocks[ 0 ].name ).toBe( 'core/updated-text-block' );
 			expect( transformedBlocks[ 0 ].isValid ).toBe( true );
 			expect( transformedBlocks[ 0 ].attributes ).toEqual( {
@@ -1028,15 +1028,15 @@ describe( 'block factory', () => {
 			// transformed block whose type matches the "destination" type gets
 			// to keep the existing block's UID.
 			expect( transformedBlocks ).toHaveLength( 2 );
-			expect( transformedBlocks[ 0 ] ).toHaveProperty( 'uid' );
-			expect( transformedBlocks[ 0 ].uid ).not.toBe( block.uid );
+			expect( transformedBlocks[ 0 ] ).toHaveProperty( 'clientId' );
+			expect( transformedBlocks[ 0 ].clientId ).not.toBe( block.clientId );
 			expect( transformedBlocks[ 0 ].name ).toBe( 'core/text-block' );
 			expect( transformedBlocks[ 0 ].isValid ).toBe( true );
 			expect( transformedBlocks[ 0 ].attributes ).toEqual( {
 				value: 'chicken ribs',
 			} );
-			expect( transformedBlocks[ 1 ].uid ).toBe( block.uid );
-			expect( transformedBlocks[ 1 ] ).toHaveProperty( 'uid' );
+			expect( transformedBlocks[ 1 ].clientId ).toBe( block.clientId );
+			expect( transformedBlocks[ 1 ] ).toHaveProperty( 'clientId' );
 			expect( transformedBlocks[ 1 ].name ).toBe( 'core/updated-text-block' );
 			expect( transformedBlocks[ 1 ].isValid ).toBe( true );
 			expect( transformedBlocks[ 1 ].attributes ).toEqual( {

diff --git a/blocks/api/test/parser.js b/blocks/api/test/parser.js
@@ -592,7 +592,7 @@ describe( 'block parser', () => {
 				url: 'http://google.com',
 				chicken: 'ribs & \'wings\'',
 			} );
-			expect( typeof parsed[ 0 ].uid ).toBe( 'string' );
+			expect( typeof parsed[ 0 ].clientId ).toBe( 'string' );
 		} );
 
 		it( 'should parse empty post content', () => {
@@ -625,7 +625,7 @@ describe( 'block parser', () => {
 			expect( parsed[ 0 ].attributes ).toEqual( {
 				content: 'Ribs',
 			} );
-			expect( typeof parsed[ 0 ].uid ).toBe( 'string' );
+			expect( typeof parsed[ 0 ].clientId ).toBe( 'string' );
 		} );
 
 		it( 'should add the core namespace to un-namespaced blocks', () => {

diff --git a/core-blocks/block/edit.js b/core-blocks/block/edit.js
@@ -90,7 +90,7 @@ class SharedBlockEdit extends Component {
 			onUpdateTitle( title );
 		}
 
-		updateAttributes( block.uid, changedAttributes );
+		updateAttributes( block.clientId, changedAttributes );
 		onSave();
 
 		this.stopEditing();
@@ -112,7 +112,7 @@ class SharedBlockEdit extends Component {
 			<BlockEdit
 				{ ...this.props }
 				isSelected={ isEditing && isSelected }
-				id={ block.uid }
+				clientId={ block.clientId }
 				name={ block.name }
 				attributes={ { ...block.attributes, ...changedAttributes } }
 				setAttributes={ isEditing ? this.setAttributes : noop }
@@ -158,7 +158,7 @@ export default compose( [
 			sharedBlock,
 			isFetching: isFetchingSharedBlock( ref ),
 			isSaving: isSavingSharedBlock( ref ),
-			block: sharedBlock ? getBlock( sharedBlock.uid ) : null,
+			block: sharedBlock ? getBlock( sharedBlock.clientId ) : null,
 		};
 	} ),
 	withDispatch( ( dispatch, ownProps ) => {

diff --git a/core-blocks/gallery/index.js b/core-blocks/gallery/index.js
@@ -137,7 +137,7 @@ export const settings = {
 					} );
 					editorMediaUpload( {
 						filesList: files,
-						onFileChange: ( images ) => onChange( block.uid, { images } ),
+						onFileChange: ( images ) => onChange( block.clientId, { images } ),
 						allowedType: 'image',
 					} );
 					return block;

diff --git a/core-blocks/test/fixtures/core-embed__animoto.json b/core-blocks/test/fixtures/core-embed__animoto.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/animoto",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__cloudup.json b/core-blocks/test/fixtures/core-embed__cloudup.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/cloudup",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__collegehumor.json b/core-blocks/test/fixtures/core-embed__collegehumor.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/collegehumor",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__dailymotion.json b/core-blocks/test/fixtures/core-embed__dailymotion.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/dailymotion",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__facebook.json b/core-blocks/test/fixtures/core-embed__facebook.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/facebook",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__flickr.json b/core-blocks/test/fixtures/core-embed__flickr.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/flickr",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__funnyordie.json b/core-blocks/test/fixtures/core-embed__funnyordie.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/funnyordie",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__hulu.json b/core-blocks/test/fixtures/core-embed__hulu.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/hulu",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__imgur.json b/core-blocks/test/fixtures/core-embed__imgur.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/imgur",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__instagram.json b/core-blocks/test/fixtures/core-embed__instagram.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/instagram",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__issuu.json b/core-blocks/test/fixtures/core-embed__issuu.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/issuu",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__kickstarter.json b/core-blocks/test/fixtures/core-embed__kickstarter.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/kickstarter",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__meetup-com.json b/core-blocks/test/fixtures/core-embed__meetup-com.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/meetup-com",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__mixcloud.json b/core-blocks/test/fixtures/core-embed__mixcloud.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/mixcloud",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__photobucket.json b/core-blocks/test/fixtures/core-embed__photobucket.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/photobucket",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__polldaddy.json b/core-blocks/test/fixtures/core-embed__polldaddy.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/polldaddy",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__reddit.json b/core-blocks/test/fixtures/core-embed__reddit.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/reddit",
         "isValid": true,
         "attributes": {

diff --git a/core-blocks/test/fixtures/core-embed__reverbnation.json b/core-blocks/test/fixtures/core-embed__reverbnation.json
@@ -1,6 +1,6 @@
 [
     {
-        "uid": "_uid_0",
+        "clientId": "_clientId_0",
         "name": "core-embed/reverbnation",
         "isValid": true,
         "attributes": {