[backend] improved code comments (#1536) #6940
Merged
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6940 +/- ##
=======================================
Coverage 67.42% 67.42%
=======================================
Files 561 561
Lines 68510 68518 +8
Branches 5713 5714 +1
=======================================
+ Hits 46191 46199 +8
Misses 22319 22319 ☔ View full report in Codecov by Sentry. |
| // only hint the first 3 ones | ||
| let name = extractRepresentative(targetsFromTrash[0]).main; | ||
| if (targetsFromTrash.length > 1) name = `${name},${extractRepresentative(targetsFromTrash[1]).main}`; | ||
| if (targetsFromTrash.length > 2) name = `${name},${extractRepresentative(targetsFromTrash[2]).main}`; |
There was a problem hiding this comment.
I think this can be simplified like this :
let name = targetsFromTrash.slice(0, 3).map((t) => extractRepresentative(t).main).join(',');
if (targetsFromTrash.length > 3) name = `${name}, ... and ${targetsFromTrash.length - 3} more`;
With a suggestion to display the number of other entities with ', ... and X more'
labo-flg
reviewed
May 14, 2024
| @@ -39,6 +39,9 @@ export const stixDelete = async (context, user, id) => { | |||
| const element = await internalLoadById(context, user, id); | |||
| if (element) { | |||
| if (isStixObject(element.entity_type) || isStixRelationship(element.entity_type)) { | |||
| // To handle delete synchronization events, we force the forceDelete flag to true, because we don't want delete events to create trash entries on synchronized platforms | |||
| // THIS IS NOT IDEAL: we ideally would need to add the forceDelete flag to all delete related methods on the API, | |||
There was a problem hiding this comment.
shall we open a new issue to "extend gql API/client-python deletion functions with forceDelete option" and keep track of it for the product team ?
There was a problem hiding this comment.
that's a good idea yes, I'll create the issue
There was a problem hiding this comment.
created the issue here #6969
labo-flg
reviewed
May 14, 2024
| const name = extractRepresentative(targetsFromTrash[0]); // only hint the first one | ||
| throw FunctionalError(`Cannot restore: a relationship targets a deleted element [${name.main}], restore it before retrying`); | ||
| // only hint the first 3 ones | ||
| let name = targetsFromTrash.slice(0, 3).map((t) => extractRepresentative(t).main).join(','); |
There was a problem hiding this comment.
Suggested change
| let name = targetsFromTrash.slice(0, 3).map((t) => extractRepresentative(t).main).join(','); | |
| let name = targetsFromTrash.slice(0, 3).map((t) => extractRepresentative(t).main).join(', '); |
labo-flg
approved these changes
May 14, 2024
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
Related issues
Checklist
Further comments