Skip to content

fix(ai-content-planner): skip empty paragraph insertion when post type has a block template #23401

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

Open
vraja-pro wants to merge 1 commit into
base: trunk
Choose a base branch
from
+109 −94
Open

fix(ai-content-planner): skip empty paragraph insertion when post type has a block template #23401

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
11 changes: 7 additions & 4 deletions packages/js/src/ai-content-planner/initialize.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,17 @@ export function insertFirstParagraph( blocks, insertBlock, isBannerRendered ) {
export const ContentPlannerEditorPlugin = () => {
const hasInserted = useRef( false );

const { isNewPost, postType, blocks, minPostsMet, isBannerRendered } = useSelect( select => {
const { isNewPost, postType, blocks, minPostsMet, isBannerRendered, hasBlockTemplate } = useSelect( select => {
const coreEditor = select( "core/editor" );
const currentPostType = coreEditor.getCurrentPostType();
const postTypeObject = select( "core" ).getPostType( currentPostType );
return {
isNewPost: coreEditor.isEditedPostNew(),
postType: coreEditor.getCurrentPostType(),
postType: currentPostType,
blocks: select( "core/block-editor" ).getBlocks(),
minPostsMet: select( CONTENT_PLANNER_STORE ).selectIsMinPostsMet(),
isBannerRendered: select( CONTENT_PLANNER_STORE ).selectIsBannerRendered(),
hasBlockTemplate: Array.isArray( postTypeObject?.template ) && postTypeObject.template.length > 0,
};
}, [] );
const hasAiStore = useSelect( select => isObject( select( STORE_NAME_AI ) ), [] );
Expand All @@ -76,12 +79,12 @@ export const ContentPlannerEditorPlugin = () => {
useYoastMetaSync();

useEffect( () => {
if ( hasInserted.current || ! isNewPost || postType !== "post" || ! minPostsMet ) {
if ( hasInserted.current || ! isNewPost || postType !== "post" || ! minPostsMet || hasBlockTemplate ) {
return;
}

hasInserted.current = insertFirstParagraph( blocks, insertBlock, isBannerRendered );
}, [ blocks, isNewPost, postType, insertBlock, minPostsMet ] );
}, [ blocks, isNewPost, postType, insertBlock, minPostsMet, hasBlockTemplate ] );

if ( ! hasAiStore ) {
return null;
Expand Down
192 changes: 102 additions & 90 deletions packages/js/tests/ai-content-planner/initialize.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,36 @@
import { render } from "../test-utils";
import { ContentPlannerEditorPlugin, registerInlineBanner } from "../../src/ai-content-planner/initialize";
import { ContentPlannerEditorPlugin, insertFirstParagraph, registerInlineBanner } from "../../src/ai-content-planner/initialize";
import { addFilter } from "@wordpress/hooks";

const mockSelectHasAiGeneratorConsent = jest.fn( () => false );
const mockSelectIsMinPostsMet = jest.fn( () => false );
const mockSelectIsBannerRendered = jest.fn( () => false );

const buildMockSelect = ( { postTypeTemplate = null } = {} ) => {
const storeMap = {
"yoast-seo/ai-generator": { selectHasAiGeneratorConsent: mockSelectHasAiGeneratorConsent },
"yoast-seo/content-planner": {
selectIsMinPostsMet: mockSelectIsMinPostsMet,
selectIsBannerRendered: mockSelectIsBannerRendered,
},
"core/editor": {
isEditedPostNew: () => false,
getCurrentPostType: () => "post",
getEditedPostAttribute: () => "",
},
"core/block-editor": { getBlocks: () => [] },
core: { getPostType: () => ( { template: postTypeTemplate } ) },
"yoast-seo/editor": { getSnippetEditorTemplates: () => ( { title: "", description: "" } ) },
};
return ( storeName ) => storeMap[ storeName ] ?? {};
};

jest.mock( "@wordpress/data", () => ( {
dispatch: jest.fn( () => ( {
updateData: jest.fn(),
setFocusKeyword: jest.fn(),
} ) ),
useSelect: jest.fn( ( mapSelect ) => {
const mockSelect = ( storeName ) => {
if ( storeName === "yoast-seo/ai-generator" ) {
return {
selectHasAiGeneratorConsent: mockSelectHasAiGeneratorConsent,
};
}
if ( storeName === "yoast-seo/content-planner" ) {
return {
selectIsMinPostsMet: mockSelectIsMinPostsMet,
selectIsBannerRendered: mockSelectIsBannerRendered,
};
}
if ( storeName === "core/editor" ) {
return {
isEditedPostNew: () => false,
getCurrentPostType: () => "post",
getEditedPostAttribute: () => "",
};
}
if ( storeName === "core/block-editor" ) {
return {
getBlocks: () => [],
};
}
if ( storeName === "yoast-seo/editor" ) {
return { getSnippetEditorTemplates: () => ( { title: "", description: "" } ) };
}
return {};
};
return mapSelect( mockSelect );
} ),
useSelect: jest.fn( ( mapSelect ) => mapSelect( buildMockSelect() ) ),
useDispatch: jest.fn( () => ( {
insertBlock: jest.fn(),
updateData: jest.fn(),
Expand Down Expand Up @@ -107,35 +95,15 @@ describe( "ContentPlannerEditorPlugin", () => {

test( "renders null when the AI generator store is not registered", () => {
const { useSelect } = require( "@wordpress/data" );
useSelect.mockImplementation( ( mapSelect ) => {
const mockSelect = ( storeName ) => {
if ( storeName === "yoast-seo/ai-generator" ) {
// Unregistered store returns undefined.
return undefined;
}
if ( storeName === "yoast-seo/content-planner" ) {
return {
selectIsMinPostsMet: () => false,
selectIsBannerRendered: () => false,
};
}
if ( storeName === "core/editor" ) {
return {
isEditedPostNew: () => false,
getCurrentPostType: () => "post",
getEditedPostAttribute: () => "",
};
}
if ( storeName === "core/block-editor" ) {
return { getBlocks: () => [] };
}
if ( storeName === "yoast-seo/editor" ) {
return { getSnippetEditorTemplates: () => ( { title: "", description: "" } ) };
}
return {};
};
return mapSelect( mockSelect );
} );
useSelect.mockImplementation( ( mapSelect ) => mapSelect( buildMockSelect() ) );

// Override only the ai-generator store to simulate it being absent.
useSelect.mockImplementation( ( mapSelect ) => mapSelect( ( storeName ) => {
if ( storeName === "yoast-seo/ai-generator" ) {
return undefined;
}
return buildMockSelect()( storeName );
} ) );

const { container } = render( <ContentPlannerEditorPlugin /> );
expect( container.firstChild ).toBeNull();
Expand All @@ -145,34 +113,7 @@ describe( "ContentPlannerEditorPlugin", () => {
mockSelectHasAiGeneratorConsent.mockReturnValue( true );

const { useSelect } = require( "@wordpress/data" );
useSelect.mockImplementation( ( mapSelect ) => {
const mockSelect = ( storeName ) => {
if ( storeName === "yoast-seo/ai-generator" ) {
return { selectHasAiGeneratorConsent: mockSelectHasAiGeneratorConsent };
}
if ( storeName === "yoast-seo/content-planner" ) {
return {
selectIsMinPostsMet: () => false,
selectIsBannerRendered: () => false,
};
}
if ( storeName === "core/editor" ) {
return {
isEditedPostNew: () => false,
getCurrentPostType: () => "post",
getEditedPostAttribute: () => "",
};
}
if ( storeName === "core/block-editor" ) {
return { getBlocks: () => [] };
}
if ( storeName === "yoast-seo/editor" ) {
return { getSnippetEditorTemplates: () => ( { title: "", description: "" } ) };
}
return {};
};
return mapSelect( mockSelect );
} );
useSelect.mockImplementation( ( mapSelect ) => mapSelect( buildMockSelect() ) );

const { getByTestId } = render( <ContentPlannerEditorPlugin /> );
expect( getByTestId( "app" ).dataset.hasConsent ).toBe( "true" );
Expand All @@ -188,6 +129,77 @@ describe( "ContentPlannerEditorPlugin", () => {
} );
} );

describe( "insertFirstParagraph", () => {
const mockInsertBlock = jest.fn();

beforeEach( () => {
mockInsertBlock.mockClear();
} );

test( "returns true immediately when the banner is already rendered", () => {
const result = insertFirstParagraph( [], mockInsertBlock, true );

expect( result ).toBe( true );
expect( mockInsertBlock ).not.toHaveBeenCalled();
} );

test( "inserts a paragraph and returns false when the canvas is empty", () => {
const result = insertFirstParagraph( [], mockInsertBlock, false );

expect( mockInsertBlock ).toHaveBeenCalledTimes( 1 );
expect( result ).toBe( false );
} );

test( "returns true without inserting when the canvas already has a paragraph", () => {
const blocks = [ { name: "core/paragraph" } ];

const result = insertFirstParagraph( blocks, mockInsertBlock, false );

expect( mockInsertBlock ).not.toHaveBeenCalled();
expect( result ).toBe( true );
} );

test( "returns false without inserting when blocks exist but none is a paragraph", () => {
const blocks = [ { name: "core/heading" } ];

const result = insertFirstParagraph( blocks, mockInsertBlock, false );

expect( mockInsertBlock ).not.toHaveBeenCalled();
expect( result ).toBe( false );
} );
} );

describe( "ContentPlannerEditorPlugin — block template guard", () => {
const mockInsertBlock = jest.fn();

beforeEach( () => {
mockInsertBlock.mockClear();
} );

test( "does not insert a paragraph when the post type has a block template", () => {
const { useSelect, useDispatch } = require( "@wordpress/data" );

mockSelectIsMinPostsMet.mockReturnValue( true );
useDispatch.mockImplementation( () => ( { insertBlock: mockInsertBlock, updateData: jest.fn(), setFocusKeyword: jest.fn() } ) );
useSelect.mockImplementation( ( mapSelect ) => mapSelect( ( storeName ) => {
if ( storeName === "core/editor" ) {
return {
isEditedPostNew: () => true,
getCurrentPostType: () => "post",
getEditedPostAttribute: () => "",
};
}
return buildMockSelect( { postTypeTemplate: [ [ "core/group", {} ] ] } )( storeName );
} ) );

render( <ContentPlannerEditorPlugin /> );

expect( mockInsertBlock ).not.toHaveBeenCalled();

mockSelectIsMinPostsMet.mockReturnValue( false );
} );
} );

describe( "registerInlineBanner", () => {
beforeEach( () => {
addFilter.mockClear();
Expand Down
Loading