[backend/frontend] enable custom overview layout for most entities (#6724) #8010
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
labo-flg
commented
Aug 9, 2024
Comment on lines
27
to
37
| overviewLayoutCustomization: [ | ||
| { key: 'details', width: 6, label: 'Entity details' }, | ||
| { key: 'basicInformation', width: 6, label: 'Basic information' }, | ||
| { key: 'task', width: 6, label: 'Tasks' }, | ||
| { key: 'originOfTheCase', width: 6, label: 'Origin of the case' }, | ||
| { key: 'observables', width: 6, label: 'Observables' }, | ||
| { key: 'otherEntities', width: 6, label: 'Other entities' }, | ||
| { key: 'externalReferences', width: 6, label: 'External references' }, | ||
| { key: 'mostRecentHistory', width: 6, label: 'Most recent history' }, | ||
| { key: 'notes', width: 12, label: 'Notes about this entity' }, | ||
| ], |
There was a problem hiding this comment.
This is how you declare the default layout when there is a module backend side.
labo-flg
commented
Aug 9, 2024
Comment on lines
1
to
21
| /** | ||
| * Placeholder for a report Module Definition | ||
| */ | ||
|
|
||
| import type { OverviewLayoutCustomization } from '../entitySetting/entitySetting-types'; | ||
| import { registerEntityOverviewLayoutCustomization } from '../../schema/overviewLayoutCustomization-register'; | ||
| import { ENTITY_TYPE_CONTAINER_REPORT } from '../../schema/stixDomainObject'; | ||
|
|
||
| const reportDefaultOverviewLayout: OverviewLayoutCustomization[] = [ | ||
| { key: 'details', width: 6, label: 'Entity details' }, | ||
| { key: 'basicInformation', width: 6, label: 'Basic information' }, | ||
| { key: 'externalReferences', width: 6, label: 'External references' }, | ||
| { key: 'mostRecentHistory', width: 6, label: 'Most recent history' }, | ||
| { key: 'notes', width: 12, label: 'Notes about this entity' }, | ||
| ]; | ||
|
|
||
| // Register only the default layout | ||
| registerEntityOverviewLayoutCustomization( | ||
| ENTITY_TYPE_CONTAINER_REPORT, | ||
| reportDefaultOverviewLayout, | ||
| ); |
There was a problem hiding this comment.
For reports, no backend module is coded yet ; still old architecture.
I chose to bootstrap a module file, only declaring the default layout.
We can start from there if/when we move reports to the module architecture.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #8010 +/- ##
==========================================
+ Coverage 65.84% 66.03% +0.18%
==========================================
Files 584 597 +13
Lines 59315 59628 +313
Branches 6068 6072 +4
==========================================
+ Hits 39056 39373 +317
+ Misses 20259 20255 -4 ☔ View full report in Codecov by Sentry. |
labo-flg
force-pushed
the
issue/6724-chunk-4
branch
4 times, most recently
from
33c1ea3
to
59fe183
Compare
labo-flg
changed the title
labo-flg
force-pushed
the
issue/6724-chunk-4
branch
2 times, most recently
from
8421b3f
to
6282e30
Compare
5 tasks
JeremyCloarec
approved these changes
Aug 21, 2024
labo-flg
force-pushed
the
issue/6724-chunk-4
branch
from
6282e30
to
6a65012
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
Replicate what was done in #7969 to most entities, namely:
Code changes are simple:
useOverviewLayoutCustomization(entityType)overview_layout_customizationfor all types of entities, enabling customization in settingsNote if there was no backend module defined for a specific entity type, I created a module folder + bootstrapped a module file that just handles the default overview layout registration.
There is also some code refactoring frontend side (JSX to TSX, class to functional component) so I can use the hook.
Related issues
Checklist