Plugin requirement hoc #260

soupette · 2017-09-28T10:18:29Z

Add pluginRequirements.js method that prevents a plugin from being rendered if some conditions aren't met.

…o content-type-builder-plugin

…plugin

…on to ProductionBlocker component

Aurelsicoko · 2017-09-28T11:13:07Z

packages/strapi-admin/admin/src/translations/fr.json

@@ -10,5 +10,9 @@
  "app.components.LeftMenuLinkContainer.noPluginsInstalled": "Aucun plugin installé",
  "app.components.LeftMenuLinkContainer.plugins": "Plugins",
  "app.components.NotFoundPage.description": "Page introuvable",
-  "app.components.NotFoundPage.back": "Retourner à la page d'accueil"
+  "app.components.NotFoundPage.back": "Retourner à la page d'accueil",
+  "components.AutoReloadBlocker.header": "L' autoReload doit être activé pour ce plugin.",


L'autoReload doit être activé pour ce plugin.

Aurelsicoko · 2017-09-28T11:13:48Z

packages/strapi-admin/config/admin.json

@@ -1,6 +1,6 @@
 {
  "languages": ["en", "fr"],
  "plugins": {


You can remove this because we don't it anymore.

Aurelsicoko · 2017-09-28T11:14:12Z

packages/strapi-helper-plugin/lib/src/app.js


 import configureStore from './store';
 import { translationMessages } from './i18n';

+const tryRequire = (bootstrap = false) => {
+  try {
+    const path = 'bootstrap';


You don't need this variable.

Aurelsicoko · 2017-09-28T11:15:01Z

packages/strapi-helper-plugin/lib/src/components/AutoReloadBlocker/index.js

+          </p>
+          <div className={styles.ide}>
+            <p>./config/environments/development/server.json</p>
+            <div>


You should use the <pre></pre> instead.

Aurelsicoko · 2017-09-28T11:16:17Z

packages/strapi-plugin-content-manager/admin/src/pluginRequirements.js

@@ -0,0 +1,3 @@
+export const shouldRenderCompo = (plugin) => new Promise((resolve) => {


export const shouldRenderCompo = (plugin) => Promise.resolve(plugin);

pierreburgy · 2017-09-28T11:20:31Z

packages/strapi-plugin-content-manager/admin/src/bootstrap.js

+    .then(menu => {
+      plugin.leftMenuSections = menu;
+
+      resole(plugin);


Please use resolve instead of resole.

pierreburgy · 2017-09-28T11:24:13Z

packages/strapi-admin/config/admin.json

@@ -1,6 +1,6 @@
 {
  "languages": ["en", "fr"],
  "plugins": {
-    "ports": [3000]
+    "ports": [3000, 5000, 8000]


This config should be removed.

pierreburgy · 2017-09-28T11:30:40Z

packages/strapi-helper-plugin/lib/src/app.js


 import configureStore from './store';
 import { translationMessages } from './i18n';

+const tryRequire = (bootstrap = false) => {


The argument should be the name of the file: fileName. So you can call the function in a more generic way: tryRequire('bootstrap'); and tryRequire('pluginRequirements');.

Tried and it didn't work that's why there was a const path = 'bootstrap'; that I forgot to delete

pierreburgy · 2017-09-28T11:32:47Z

packages/strapi-admin/admin/src/app.js

+  switch (true) {
+    // Execute bootstrap function and check if plugin can be rendered
+    case isFunction(plugin.bootstrap) && isFunction(plugin.pluginRequirements):
+      plugin.pluginRequirements(plugin)


Avoid nested promises:

plugin.pluginRequirements(plugin) .then(plugin => { return plugin.bootstrap(plugin); }) .then(plugin => { store.dispatch(pluginLoaded(plugin)); });

pierreburgy · 2017-09-28T11:37:30Z

packages/strapi-helper-plugin/lib/src/app.js

+  try {
+    const path = 'bootstrap';
+    const config = bootstrap ? require('bootstrap').bootstrap : require('pluginRequirements').shouldRenderCompo;
+    return config;


Use a dynamic return: return require(fileName);

Can't do that since passing a fileName parameter didn't work

pierreburgy · 2017-09-28T11:37:50Z

packages/strapi-plugin-content-manager/admin/src/bootstrap.js

+import { generateMenu } from 'containers/App/sagas';
+
+// This method is executed before the load of the plugin
+export const bootstrap = (plugin) => new Promise((resole, reject) => {


Export as default function.

pierreburgy · 2017-09-28T11:38:25Z

packages/strapi-plugin-content-manager/admin/src/pluginRequirements.js

@@ -0,0 +1,3 @@
+export const shouldRenderCompo = (plugin) => new Promise((resolve) => {


Export as default.

The name of the file should be requirements.js instead of pluginRequirements.js in order to be consistent with bootstrap.js.

pierreburgy · 2017-09-28T11:42:59Z

packages/strapi-helper-plugin/lib/src/components/AutoReloadBlocker/index.js

+        <div>
+
+          <h4>
+            <FormattedMessage id="components.AutoReloadBlocker.header" />


Wouldn't better to create a single, but dynamic Blocker component, that support props like title, description and content (which could even be a component defined in the plugin)?

The plugin is in charge of telling which component to render if we prevent it from being displayed. In this case passing such logic is a bit more complex and since we're rendering stateless component instead of the plugin itself I thought that having two different blockers or whatever other component provided by the plugin is a great deal.

Aurelsicoko · 2017-09-28T14:53:56Z

LGTM

soupette added 7 commits September 27, 2017 17:54

Add pluginRequirements function to block plugin rendering

937a1a9

Created autoReloadblocker component and add pluginRequirements file t…

8b73665

…o content-type-builder-plugin

Created Production blocker component

ac11c46

Remove unknow props in content header button in content-type-builder …

06df528

…plugin

Add environment check to settings-manager pluginRequirement, add butt…

6f2310e

…on to ProductionBlocker component

Add bootstrap file to content-manager plugin

76ae6ee

fix conflict

2772219

soupette requested review from Aurelsicoko, pierreburgy and lauriejim September 28, 2017 11:05

Aurelsicoko reviewed Sep 28, 2017

View reviewed changes

pierreburgy reviewed Sep 28, 2017

View reviewed changes

soupette added 5 commits September 28, 2017 14:00

Fix PR feedback

2a6dc8c

Export default in pluginRequirements and bootstrap files

594c383

Fix conflict

9b71c2b

Remove logs, and hange params name

5a1fae5

Change pluginRequirements file to requirements

a033d97

Aurelsicoko merged commit 29f89e0 into alpha.6 Sep 29, 2017

Aurelsicoko deleted the plugin-requirement-hoc branch September 29, 2017 09:19

This was referenced Jul 17, 2020

[Snyk] Fix for 1 vulnerabilities ebarahona/strapi#71

Open

[Snyk] Fix for 1 vulnerabilities Bhanditz/strapi#60

Open

snyk-bot mentioned this pull request Nov 10, 2021

[Snyk] Fix for 1 vulnerabilities songshansitulv/strapi#97

Open

snyk-bot mentioned this pull request Nov 5, 2022

[Snyk] Fix for 1 vulnerabilities songshansitulv/strapi#126

Open

subsy mentioned this pull request Nov 5, 2022

[Snyk] Fix for 1 vulnerabilities subsy/strapi#178

Open

Bhanditz mentioned this pull request Nov 5, 2022

[Snyk] Fix for 1 vulnerabilities Bhanditz/strapi#115

Open

ebarahona mentioned this pull request Nov 5, 2022

[Snyk] Fix for 1 vulnerabilities ebarahona/strapi#125

Open

ebarahona mentioned this pull request Dec 25, 2022

[Snyk] Fix for 1 vulnerabilities ebarahona/strapi#129

Open

snyk-bot mentioned this pull request Dec 25, 2022

[Snyk] Fix for 1 vulnerabilities songshansitulv/strapi#135

Open

subsy mentioned this pull request Dec 26, 2022

[Snyk] Fix for 1 vulnerabilities subsy/strapi#184

Open

Bhanditz mentioned this pull request Dec 26, 2022

[Snyk] Fix for 1 vulnerabilities Bhanditz/strapi#120

Open

Bhanditz mentioned this pull request Jun 25, 2023

[Snyk] Fix for 14 vulnerabilities Bhanditz/strapi#130

Open

Bhanditz mentioned this pull request Nov 26, 2023

[Snyk] Fix for 16 vulnerabilities Bhanditz/strapi#146

Open

songshansitulv mentioned this pull request Nov 27, 2023

[Snyk] Fix for 9 vulnerabilities songshansitulv/strapi#159

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Plugin requirement hoc #260

Plugin requirement hoc #260

soupette commented Sep 28, 2017

Aurelsicoko Sep 28, 2017

Aurelsicoko Sep 28, 2017

Aurelsicoko Sep 28, 2017

Aurelsicoko Sep 28, 2017

Aurelsicoko Sep 28, 2017

pierreburgy Sep 28, 2017

pierreburgy Sep 28, 2017

pierreburgy Sep 28, 2017

soupette Sep 28, 2017 •

edited

pierreburgy Sep 28, 2017

pierreburgy Sep 28, 2017

soupette Sep 28, 2017

pierreburgy Sep 28, 2017

pierreburgy Sep 28, 2017

pierreburgy Sep 28, 2017

pierreburgy Sep 28, 2017

soupette Sep 28, 2017 •

edited

Aurelsicoko commented Sep 28, 2017

		@@ -0,0 +1,3 @@
		export const shouldRenderCompo = (plugin) => new Promise((resolve) => {

Plugin requirement hoc #260

Plugin requirement hoc #260

Conversation

soupette commented Sep 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soupette Sep 28, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soupette Sep 28, 2017 • edited

Choose a reason for hiding this comment

Aurelsicoko commented Sep 28, 2017

soupette Sep 28, 2017 •

edited

soupette Sep 28, 2017 •

edited