[backend/frontend] Introduce dev flags to deactivate feature in ongoing development #5802

richard-julien · 2024-02-02T23:14:25Z

This PR aims to introduce a dev configuration to disable features that are currently in development but not ready yet.
That's will ease the merging of large feature but providing simple tools to hide the feature.

In this PR you will find a example of Decay indicator feature deactivation.

Deactivation of the manager registration
Deactivation of the module registration
Deactivation of a frontend specific menu

codecov · 2024-02-02T23:44:33Z

Codecov Report

Attention: 58 lines in your changes are missing coverage. Please review.

Comparison is base (ae28815) 64.82% compared to head (1864cb6) 64.75%.
Report is 6 commits behind head on master.

❗ Current head 1864cb6 differs from pull request most recent head d0b0952. Consider uploading reports for the commit d0b0952 to get more accurate results

Files	Patch %	Lines
...opencti-graphql/src/modules/indicator/indicator.ts	8.62%	53 Missing ⚠️
...encti-graphql/src/manager/indicatorDecayManager.ts	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5802      +/-   ##
==========================================
- Coverage   64.82%   64.75%   -0.08%     
==========================================
  Files         521      521              
  Lines       61348    61366      +18     
  Branches     4900     4905       +5     
==========================================
- Hits        39770    39737      -33     
- Misses      21578    21629      +51

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

aHenryJard

I just did a PR review, I did not tried it yet.

To avoid mispelling, I think it's better to have the 'ed' everywhere (enabled, disabled, activated etc..) so I did suggestions in that way.

aHenryJard · 2024-02-05T07:27:57Z

opencti-platform/opencti-front/src/private/components/settings/CustomizationMenu.tsx


 const CustomizationMenu: FunctionComponent = () => {
+  const { isFeatureEnable } = useHelper();


Suggested change

const { isFeatureEnable } = useHelper();

const { isFeatureEnabled } = useHelper();

aHenryJard · 2024-02-05T07:28:06Z

opencti-platform/opencti-front/src/private/components/settings/CustomizationMenu.tsx

@@ -19,6 +21,10 @@ const CustomizationMenu: FunctionComponent = () => {
      path: '/dashboard/settings/customization/retention',
      label: 'Retention policies',
    },
+    ...(isFeatureEnable('INDICATOR_DECAY') ? [{


Suggested change

...(isFeatureEnable('INDICATOR_DECAY') ? [{

...(isFeatureEnabled('INDICATOR_DECAY') ? [{

aHenryJard · 2024-02-05T07:29:57Z

opencti-platform/opencti-front/src/utils/platformModulesHelper.ts

@@ -36,7 +36,7 @@ const isFeatureEnable = (
 ) => {
  const flags = settings.platform_feature_flags ?? [];
  const feature = flags.find((f) => f.id === id);
-  return feature !== undefined && feature.enable === true;
+  return feature === undefined || feature.enable === true;


Suggested change

return feature === undefined || feature.enable === true;

return feature === undefined || feature.enabled === true;

aHenryJard · 2024-02-05T07:30:05Z

opencti-platform/opencti-front/src/private/components/settings/Settings.jsx

-                                label={
-                                  module.enable ? t_i18n('Enabled') : t_i18n('Disabled')
-                                }
+                                label={module.enable ? t_i18n('Enabled') : t_i18n('Disabled')}


Suggested change

label={module.enable ? t_i18n('Enabled') : t_i18n('Disabled')}

label={module.enabled ? t_i18n('Enabled') : t_i18n('Disabled')}

labo-flg · 2024-02-05T07:51:15Z

Let's enable all feature flags in the backend tests, to cover the code during development even if not enabled in production yet.

richard-julien · 2024-02-05T09:51:48Z

I just did a PR review, I did not tried it yet.

To avoid mispelling, I think it's better to have the 'ed' everywhere (enabled, disabled, activated etc..) so I did suggestions in that way.

That's a good point but there is more work and alignment to do than your proposal to really align everything around "enabled" like the modules that share the graphql object for the result. Modules "enable" is currently written in redis so the modification of the name must be changed carefully.

For now i will propose to only focus on the flag here and do the change of semantic in another PR

aHenryJard

Tested locally on Decay feature, it's working as expected.

I tested:

without disabled_dev_features => decay hidden, ok
with disabled_dev_features empty => decay enabled, ok
with disabled_dev_features = ['INDICATOR_DECAY'] => decay hidden, ok

richard-julien · 2024-02-05T10:26:20Z

Let's enable all feature flags in the backend tests, to cover the code during development even if not enabled in production yet.

Done

richard-julien added 2 commits February 3, 2024 00:09

[backend/frontend] Introduce dev flags

024c12b

[backend/frontend] Add support for module registration

156150c

richard-julien added feature use for describing a new feature to develop architecture improvement Architecture refactor or improvement is needed labels Feb 2, 2024

richard-julien self-assigned this Feb 2, 2024

[backend] Try to activate only the registration attributes

1864cb6

SamuelHassine force-pushed the master branch 4 times, most recently from 3972324 to 3d01224 Compare February 4, 2024 22:22

aHenryJard reviewed Feb 5, 2024

View reviewed changes

Kedae added filigran team use to identify PR from the Filigran team and removed feature use for describing a new feature to develop labels Feb 5, 2024

[backend] Move config in app, empty list of disable in test config

d0b0952

aHenryJard approved these changes Feb 5, 2024

View reviewed changes

[frontend] Remove sample of menu deactivation

26c8bb0

labo-flg approved these changes Feb 5, 2024

View reviewed changes

richard-julien merged commit af7ab66 into master Feb 5, 2024
5 of 6 checks passed

richard-julien deleted the oob/dev_flags branch February 5, 2024 20:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[backend/frontend] Introduce dev flags to deactivate feature in ongoing development #5802

[backend/frontend] Introduce dev flags to deactivate feature in ongoing development #5802

richard-julien commented Feb 2, 2024

codecov bot commented Feb 2, 2024 •

edited

aHenryJard left a comment

aHenryJard Feb 5, 2024

aHenryJard Feb 5, 2024

aHenryJard Feb 5, 2024

aHenryJard Feb 5, 2024

labo-flg commented Feb 5, 2024

richard-julien commented Feb 5, 2024 •

edited

aHenryJard left a comment

richard-julien commented Feb 5, 2024


		const CustomizationMenu: FunctionComponent = () => {
		const { isFeatureEnable } = useHelper();

	const { isFeatureEnable } = useHelper();
	const { isFeatureEnabled } = useHelper();

	...(isFeatureEnable('INDICATOR_DECAY') ? [{
	...(isFeatureEnabled('INDICATOR_DECAY') ? [{

	return feature === undefined \|\| feature.enable === true;
	return feature === undefined \|\| feature.enabled === true;

	label={module.enable ? t_i18n('Enabled') : t_i18n('Disabled')}
	label={module.enabled ? t_i18n('Enabled') : t_i18n('Disabled')}

[backend/frontend] Introduce dev flags to deactivate feature in ongoing development #5802

[backend/frontend] Introduce dev flags to deactivate feature in ongoing development #5802

Conversation

richard-julien commented Feb 2, 2024

codecov bot commented Feb 2, 2024 • edited

Codecov Report

aHenryJard left a comment

Choose a reason for hiding this comment

aHenryJard Feb 5, 2024

Choose a reason for hiding this comment

aHenryJard Feb 5, 2024

Choose a reason for hiding this comment

aHenryJard Feb 5, 2024

Choose a reason for hiding this comment

aHenryJard Feb 5, 2024

Choose a reason for hiding this comment

labo-flg commented Feb 5, 2024

richard-julien commented Feb 5, 2024 • edited

aHenryJard left a comment

Choose a reason for hiding this comment

richard-julien commented Feb 5, 2024

codecov bot commented Feb 2, 2024 •

edited

richard-julien commented Feb 5, 2024 •

edited