294 correctly use and bundle yoastseo package in premium #21006

FAMarfuaty · 2023-12-22T14:09:56Z

Context

Summary

This PR can be summarized in the following changelog entry:

[yoastseo] Refactors classes ProminentWord, AssessmentResult, Mark, and Paper to use class notation.
[yoastseo] Cleans up the helper modules that are exposed in languageProcessing. Now they are grouped together as processingHelpers.
Uses the build code from yoastseo package in the plugin.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

Relevant test scenarios

Changes should be tested with the browser console open
Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
Changes should be tested on different editors (Block/Classic/Elementor/other)
Changes should be tested on different browsers
Changes should be tested on multisite

Test instructions for QA when the code is in the RC

QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

UI changes

This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

I have written documentation for this change.

Quality assurance

I have tested this code to the best of my abilities.
During testing, I had activated all plugins that Yoast SEO provides integrations for.
I have added unit tests to verify the code works as intended.
If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
I have written this PR in accordance with my team's definition of done.
I have checked that the base branch is correctly set.

Innovation

No innovation project is applicable for this PR.
This PR falls under an innovation project. I have attached the innovation label.
I have added my hours to the WBSO document.

Fixes #

…nt Babel from transpiling ES6 modules to CommonJS. This way, webpack can analyze more accurately the dependency tree and shake off unused dependencies.

FAMarfuaty · 2024-01-03T10:41:09Z

packages/yoastseo/babel.config.js

+	presets: [
+		[
+			"@babel/preset-env", {
+				modules: false,


Setting modules to false is to make sure that the code is not bundled in CommonJS. For treeshaking to work, the module needs to be bundled in ES2015 syntax (from this source and this source). The default value is set to auto.
Tree shaking doesn't work with CommonJS modules and only works with ES modules

However, Babel's docs mentions that we should only set it to false when we intend to ship native ES Modules to browsers. So I am not entirely sure about this. cc @mhkuu @mykola

Additionally, I found out that apparently yarn test is failing with SyntaxError: Cannot use import statement outside a module message when I set modules to false.

This is because the following:

Before running test, we're running yarn build, where we build ECMAScript modules when modules is set to false in babel.config.js

We use the build modules for testing

When running yarn test, jest is using CommonJS modules by default. Hence the failing tests

Fixed by adjusting the config to still transform the modules to CommonJS when it's for testing. From this article. Props to @mhkuu for finding it! 🙌🏽

FAMarfuaty · 2024-01-03T10:48:16Z

packages/yoastseo/src/languageProcessing/index.js

 	AbstractResearcher,
-	transliterate,
-	replaceDiacritics,
-	createRegexFromArray,
-	imageInText,
-	stripSpaces,
-	baseStemmer,
-	getWords,
-	flattenSortLength,
-	indices,
-	buildFormRule,
-	createRulesFromArrays,
-	createSingleRuleFromArray,
-	matchRegularParticiples,
-	directPrecedenceException,
-	precedenceException,
-	nonDirectPrecedenceException,
-	findMatchingEndingInArray,
-	regexHelpers,
-	exceptionListHelpers,
-	stemHelpers,
-	areWordsInSentence,
-	values,
-	getClauses,
-	getClausesSplitOnStopWords,
-	stripHTMLTags,
-	stripBlockTagsAtStartEnd,
-	countMetaDescriptionLength,
-	sanitizeString,
-	removePunctuation,
-	getLanguage,
-	getSentences,
-	getFieldsToMark,
-	unifyAllSpaces,
-	normalizeHTML,
-	collectMarkingsInSentence,
-	normalizeSingle,
-	parseSynonyms,
-	mergeListItems,
-	findWordFormsInString,
-	markWordsInSentences,
-	helpers,
-	researches,
-	languageHelpers,


I expose these helpers from languageProcessing/helpers as processingHelpers. This way this index.js file is cleaner

FAMarfuaty · 2024-01-03T10:53:02Z

config/webpack/webpack.config.js

@@ -55,7 +55,7 @@ module.exports = [
 		{
 			entry: languages.reduce( ( memo, language ) => {
 				const name = ( language === "_default" ) ? "default" : language;
-				memo[ name ] = "./node_modules/yoastseo/src/languageProcessing/languages/" + language + "/Researcher";
+				memo[ name ] = "./node_modules/yoastseo/build/languageProcessing/languages/" + language + "/Researcher";


When we create bundled entries for language specific Researcher in Free, I change it so that we use the build code from yoastseo. Actually now I am not so sure anymore 😅 . I vaguely remember that we want to use the build code, but is it also when it's used in Free? 🤔

This means that when building the plugin, we should also build the package.

…nto 294-correctly-use-and-bundle-yoastseo-package-in-premium

… accessed from the Class itself and not from the object instance of the class.

…lass, which means that it cannot be accessed from an object instance of that class.

…raseDensity`

FAMarfuaty · 2024-01-16T15:45:06Z

packages/yoastseo/spec/languageProcessing/values/SentenceSpec.js

-				} ],
-			_isPassive: true,
-			_sentenceText: "Cats are adored.",
-		} );


Testing parse method of the class here is irrelevant since now this method cannot be accessed from an instance of this class. The parse method is made static

…nto 294-correctly-use-and-bundle-yoastseo-package-in-premium

github-actions · 2024-12-24T02:56:37Z

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

FAMarfuaty added 6 commits December 22, 2023 14:59

Specifying modules: false in the `@babel/preset-env config to preve…

a4b61d5

…nt Babel from transpiling ES6 modules to CommonJS. This way, webpack can analyze more accurately the dependency tree and shake off unused dependencies.

Add back missing spaces

40c7880

Bundle language entries based on the build code of yoastseo package

2e51793

Group the language processing helpers into one module

4ffb462

Adjust imports

d4d1098

Adjust import

e6aa3be

FAMarfuaty commented Jan 3, 2024

View reviewed changes

FAMarfuaty added 20 commits January 4, 2024 09:56

Fix typos

564bbe4

Merge branch 'releasing-yoastseo' of github.com:Yoast/wordpress-seo i…

dbadc81

…nto 294-correctly-use-and-bundle-yoastseo-package-in-premium

Compile code to CommonJS when test is running

73fc90f

Improve exporting syntax

0ac32f7

Add eslint plugin for tree shaking

b97808c

Add tree shaking config

7b61e10

Disable tree-shaking plugin for spec folder

d792697

Refactor classes to use newer syntax with class keyword

37d3a9a

Upgrade dependencies

1bdd161

Adjust unit tests

d87b712

use import statement instead of require

5f7a0e8

Add exception to tree shaking config rule

006e5c2

Refactor the class

967d44a

Explicitly make parse method static. This way this method can only be…

349f89d

… accessed from the Class itself and not from the object instance of the class.

Remove irrelevant tests. Now parse method is a static method of the c…

02ec24e

…lass, which means that it cannot be accessed from an object instance of that class.

Fix import statement

58f0c0b

Fix a copy paste mistake. getKeywordDensity should return `getKeyph…

c361c6c

…raseDensity`

Remove unnecessary import

4a60b42

refactor AssessorPresenter to use class

aaa0463

Fix the way we access the parse method

e1f0a21

FAMarfuaty commented Jan 16, 2024

View reviewed changes

FAMarfuaty added 4 commits January 18, 2024 13:47

Merge branch 'releasing-yoastseo' of github.com:Yoast/wordpress-seo i…

c665001

…nto 294-correctly-use-and-bundle-yoastseo-package-in-premium

Upgrade dependencies

7c8feee

Merge branch 'releasing-yoastseo' of github.com:Yoast/wordpress-seo i…

01d52a5

…nto 294-correctly-use-and-bundle-yoastseo-package-in-premium

Add rule to exclude parsing source map from parse5

845ce24

Base automatically changed from releasing-yoastseo to trunk April 2, 2024 13:23

github-actions bot added the merge conflict label Dec 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

294 correctly use and bundle yoastseo package in premium #21006

294 correctly use and bundle yoastseo package in premium #21006

FAMarfuaty commented Dec 22, 2023 •

edited

Loading

FAMarfuaty Jan 3, 2024 •

edited

Loading

FAMarfuaty Jan 4, 2024

FAMarfuaty Jan 5, 2024

FAMarfuaty Jan 3, 2024

FAMarfuaty Jan 3, 2024 •

edited

Loading

FAMarfuaty Jan 4, 2024

FAMarfuaty Jan 16, 2024

github-actions bot commented Dec 24, 2024

294 correctly use and bundle yoastseo package in premium #21006

Are you sure you want to change the base?

294 correctly use and bundle yoastseo package in premium #21006

Conversation

FAMarfuaty commented Dec 22, 2023 • edited Loading

Context

Summary

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

Relevant test scenarios

Test instructions for QA when the code is in the RC

Impact check

UI changes

Other environments

Documentation

Quality assurance

Innovation

FAMarfuaty Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

FAMarfuaty Jan 4, 2024

Choose a reason for hiding this comment

FAMarfuaty Jan 5, 2024

Choose a reason for hiding this comment

FAMarfuaty Jan 3, 2024

Choose a reason for hiding this comment

FAMarfuaty Jan 3, 2024 • edited Loading

Choose a reason for hiding this comment

FAMarfuaty Jan 4, 2024

Choose a reason for hiding this comment

FAMarfuaty Jan 16, 2024

Choose a reason for hiding this comment

github-actions bot commented Dec 24, 2024

FAMarfuaty commented Dec 22, 2023 •

edited

Loading

FAMarfuaty Jan 3, 2024 •

edited

Loading

FAMarfuaty Jan 3, 2024 •

edited

Loading