[backend] Apply PRs suggestions after review

Author: fellowseb

opencti-platform/opencti-dev/docker-compose.yml

@@ -122,7 +122,7 @@ services:
       - 15672:15672
 
   ## Telemetry + tracing dependencies
-  ## docker compose --profile telemetry up -d (launch everything + telemetry)
+  ## podman compose --profile telemetry up -d (launch everything + telemetry)
   opencti-dev-telemetry-pyroscope:
     container_name: opencti-pyroscope
     image: grafana/pyroscope

opencti-platform/opencti-graphql/src/database/attachment-processor-props.ts

@@ -175,7 +175,6 @@ import { DRAFT_OPERATION_CREATE, DRAFT_OPERATION_DELETE, DRAFT_OPERATION_DELETE_
 import { RELATION_SAMPLE } from '../modules/malwareAnalysis/malwareAnalysis-types';
 import { asyncMap } from '../utils/data-processing';
 import { doYield } from '../utils/eventloop-utils';
-import type { Mutable } from '../utils/type-utils';
 import { RELATION_COVERED } from '../modules/securityCoverage/securityCoverage-types';
 import type { AuthContext, AuthUser } from '../types/user';
 import type {
@@ -310,7 +309,39 @@ export const elConfigureAttachmentProcessor = async (): Promise<boolean> => {
           attachment: {
             field: 'file_data',
             remove_binary: true,
-            properties: ATTACHMENT_PROCESSOR_EXTRACTED_PROPS_ELASTICSEARCH as Mutable<typeof ATTACHMENT_PROCESSOR_EXTRACTED_PROPS_ELASTICSEARCH>,
+            // List of fields extracted by the attachment ingest processor.
+            // The full list is available in the Elasticsearch docs:
+            // (https://www.elastic.co/guide/en/elasticsearch/reference/8.19/attachment.html#attachment-fields).
+            properties: [
+              'content',
+              'title',
+              'author',
+              'keywords',
+              'date',
+              'content_type',
+              'content_length',
+              'language',
+              'modified',
+              'format',
+              // identifier,     NOT EXTRACTED
+              // contributor,    NOT EXTRACTED
+              // coverage,       NOT EXTRACTED
+              'modifier',
+              'creator_tool',
+              // publisher,      NOT EXTRACTED
+              // relation,       NOT EXTRACTED
+              // rights,         NOT EXTRACTED
+              // source,         NOT EXTRACTED
+              // type,           NOT EXTRACTED
+              'description',
+              'print_date',
+              'metadata_date',
+              // latitude,       NOT EXTRACTED
+              // longitude,      NOT EXTRACTED
+              // altitude,       NOT EXTRACTED
+              // rating,         NOT EXTRACTED
+              'comments',
+            ],
           },
         },
       ],
@@ -327,7 +358,21 @@ export const elConfigureAttachmentProcessor = async (): Promise<boolean> => {
           {
             attachment: {
               field: 'file_data',
-              properties: ATTACHMENT_PROCESSOR_EXTRACTED_PROPS_OPENSEARCH as Mutable<typeof ATTACHMENT_PROCESSOR_EXTRACTED_PROPS_OPENSEARCH>,
+              // List of fields extracted by the attachment ingest processor, for OpenSearch.
+              // The full list is available in the OS docs:
+              // (https://docs.opensearch.org/latest/install-and-configure/additional-plugins/ingest-attachment-plugin/#extracted-information),
+              // and code shows the check rejects unknown fields with an exception:
+              // https://github.com/opensearch-project/OpenSearch/blob/315481148edaa43410e2e9f1801ec903fd62ec20/plugins/ingest-attachment/src/main/java/org/opensearch/ingest/attachment/AttachmentProcessor.java#L277
+              properties: [
+                'content',
+                'title',
+                'author',
+                'keywords',
+                'date',
+                'content_type',
+                'content_length',
+                'language',
+              ],
             },
           },
           {
@@ -2746,11 +2791,11 @@ const buildSubQueryForFilterGroup = (
 
   const currentSubQuery = localMustFilters.length > 0
     ? {
-      bool: {
-        should: localMustFilters,
-        minimum_should_match: mode === 'or' ? 1 : localMustFilters.length,
-      },
-    }
+        bool: {
+          should: localMustFilters,
+          minimum_should_match: mode === 'or' ? 1 : localMustFilters.length,
+        },
+      }
     : null;
   return { subQuery: currentSubQuery, postFiltersTags: localPostFilterTags, resultSaltCount: localSaltCount };
 };
@@ -3123,12 +3168,12 @@ const tagFiltersForPostFiltering = (
 ) => {
   const taggedFilters: (Filter & { postFilteringTag: string })[] = filters
     ? extractFiltersFromGroup(filters, [INSTANCE_REGARDING_OF, INSTANCE_DYNAMIC_REGARDING_OF])
-      .filter((filter) => isEmptyField(filter.operator) || filter.operator === 'eq')
-      .map((filter, i) => {
-        const taggedFilter = filter as Filter & { postFilteringTag: string };
-        taggedFilter.postFilteringTag = `${i}`;
-        return taggedFilter;
-      })
+        .filter((filter) => isEmptyField(filter.operator) || filter.operator === 'eq')
+        .map((filter, i) => {
+          const taggedFilter = filter as Filter & { postFilteringTag: string };
+          taggedFilter.postFilteringTag = `${i}`;
+          return taggedFilter;
+        })
     : [];
 
   if (taggedFilters.length > 0) {

opencti-platform/opencti-graphql/src/database/engine.ts

@@ -1,13 +1,11 @@
-import { assertType } from '../../../utils/type-utils';
-import type { AttachmentProcessorExtractedProp } from '../../../database/attachment-processor-props';
 import { ENTITY_TYPE_INTERNAL_FILE } from '../../../schema/internalObject';
 import { schemaAttributesDefinition } from '../../../schema/schema-attributes';
 import { type AttributeDefinition, createdAt, creators, entityType, id, internalId, parentTypes, refreshedAt, standardId, updatedAt } from '../../../schema/attribute-definition';
 import { ENTITY_TYPE_MARKING_DEFINITION } from '../../../schema/stixMetaObject';
 import { ABSTRACT_STIX_CORE_OBJECT } from '../../../schema/general';
 import { UPLOAD_STATUS_VALUES } from './document-domain';
 
-const attributes = [
+const attributes: Array<AttributeDefinition> = [
   id,
   internalId,
   standardId,
@@ -95,17 +93,6 @@ const attributes = [
   { name: 'file_id', label: 'File identifier', type: 'string', format: 'short', mandatoryType: 'internal', editDefault: false, multiple: false, upsert: false, isFilterable: false },
   { name: 'entity_id', label: 'Related entity', type: 'string', format: 'id', entityTypes: [ABSTRACT_STIX_CORE_OBJECT], mandatoryType: 'internal', editDefault: false, multiple: false, upsert: false, isFilterable: false },
   { name: 'removed', label: 'Removed', type: 'boolean', mandatoryType: 'no', editDefault: false, multiple: false, upsert: false, isFilterable: false },
-] as const satisfies Array<AttributeDefinition>;
-
-const attachmentAttributes = attributes[18];
-
-type AttachmentAttributeMappingNames = typeof attachmentAttributes.mappings[number]['name'][];
-
-// Make sure there's an attachment mapping for each field extracted
-// by the `attachment` ingest processor, exhaustively.
-assertType<
-  AttachmentAttributeMappingNames,
-  AttachmentProcessorExtractedProp[]
->(attachmentAttributes.mappings.map(({ name }) => name));
+];
 
 schemaAttributesDefinition.registerAttributes(ENTITY_TYPE_INTERNAL_FILE, attributes);