[Inventory][ECO] Replace `Entity` with `InventoryEntityLatest` type #198760

crespocarlos · 2024-11-04T10:14:32Z

closes #198758

Summary

This PR removes the Entity type used across the Inventory and replaces it with InventoryEntityLatest, which provides strong typing for the latest entity object. This change makes the code leverage TypeScript’s intellisense and autocompletion in the editor, making the code easier to work with and more maintainable across the codebase.

InventoryEntityLatest is the interface that the API returns and what the UI consumes. Note that this is distinct from the index mapping defined by entityLatestSchema, creating a separation layer between Elasticsearch and the UI.

crespocarlos · 2024-11-04T17:02:05Z

x-pack/packages/kbn-entities-schema/src/schema/entity.ts

@@ -11,9 +11,9 @@ import { arrayOfStringsSchema } from './common';
 export const entityBaseSchema = z.object({
  id: z.string(),
  type: z.string(),
-  identity_fields: arrayOfStringsSchema,
+  identity_fields: z.union([arrayOfStringsSchema, z.string()]),


esql returns a string when fields hold a single value.

crespocarlos · 2024-11-04T17:02:15Z

x-pack/packages/kbn-entities-schema/src/schema/entity.ts

  display_name: z.string(),
-  metrics: z.record(z.string(), z.number()),
+  metrics: z.optional(z.record(z.string(), z.number())),


perhaps we should remove this?

The framework still supports metrics even if the Inventory doesn't use it, let's leave this for now

...ugins/observability_solution/inventory/public/components/entities_grid/entity_name/index.tsx

...ability_solution/inventory/public/components/grouped_inventory/inventory_group_accordion.tsx

x-pack/plugins/observability_solution/inventory/server/routes/entities/get_entity_types.ts

crespocarlos · 2024-11-04T17:13:25Z

/ci

crespocarlos · 2024-11-05T17:12:39Z

x-pack/plugins/observability_solution/inventory/common/entities.ts

+export type InventoryEntityLatest = {
+  entityId: string;
+  entityType: string;
+  entityIdentityFields: string | string[];
+  entityDisplayName: string;
+  entityDefinitionId: string;
+  entityLastSeenTimestamp: string;
+  entityDefinitionVersion: string;
+  entitySchemaVersion: string;
  alertsCount?: number;
-};
+} & z.infer<typeof entityMetadataSchema>;


The idea here is to make the API return an interface that doesn't depend in the index mapping. The Metadata, however, will return the objects as they are returned from the query

crespocarlos · 2024-11-05T17:23:28Z

@elasticmachine merge upstream

crespocarlos · 2024-11-05T17:23:36Z

/ci

x-pack/plugins/observability_solution/inventory/public/hooks/use_detail_view_redirect.ts

…ypes

elasticmachine · 2024-11-08T21:33:43Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 38ffdc2
Storybooks Preview
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-198760-38ffdc2f36d3

Failed CI Steps

FTR Configs #34

Test Failures

[job] [logs] FTR Configs #34 / @ess @serverless SecuritySolution Explore Overview Overview Network With packetbeat Make sure that we get OverviewNetwork data

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/entities-schema`	43	45	+2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`home`	152.0KB	151.9KB	-39.0B
`inventory`	233.7KB	233.7KB	+19.0B
total			-20.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`inventory`	12.4KB	12.3KB	-58.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/entities-schema`	43	45	+2

History

💔 Build #249719 failed 3f06d21
💔 Build #249649 failed b046148
💔 Build #249577 failed a186a60
💔 Build #249547 failed 33832dc
💛 Build #249196 was flaky 8d8df1c

crespocarlos · 2024-11-11T08:20:46Z

@elasticmachine merge upstream

x-pack/packages/observability/observability_utils/es/client/create_observability_es_client.ts

cauemarcondes · 2024-11-11T09:49:17Z

x-pack/plugins/entity_manager/public/lib/entity_client.ts

-    const identityFieldsValue = this.getIdentityFieldsValue(entityLatest);
+  asKqlFilter(
+    entityInstance: {
+      entity: Pick<EntityInstance['entity'], 'identity_fields'>;


This is not an entity this is an identity_fields, can 't you create a type for the identity_fields and use it here and in the entityBaseSchema?

const identityFieldsSchema = z.union([arrayOfStringsSchema, z.string()]); export type IdentityFields = z.infer<typeof identityFieldsSchema>; export const entityBaseSchema = z.object({ id: z.string(), type: z.string(), identity_fields: identityFieldsSchema,

Suggested change

entity: Pick<EntityInstance['entity'], 'identity_fields'>;

identityFields: IdentityFields;

This is a partial entity. I'll see if this can be improved.

x-pack/plugins/observability_solution/inventory/common/utils/entity_type_guards.ts

x-pack/plugins/observability_solution/inventory/server/routes/entities/get_entity_types.ts

…ypes

cauemarcondes

LGTM

miltonhultgren

Entities changes LGTM

miltonhultgren · 2024-11-12T11:04:17Z

x-pack/packages/kbn-entities-schema/src/schema/entity.ts

  display_name: z.string(),
-  metrics: z.record(z.string(), z.number()),
+  metrics: z.optional(z.record(z.string(), z.number())),


The framework still supports metrics even if the Inventory doesn't use it, let's leave this for now

crespocarlos · 2024-11-12T15:05:35Z

@elasticmachine merge upstream

elasticmachine · 2024-11-12T16:05:16Z

💚 Build Succeeded

Buildkite Build
Commit: 3b5540d
Storybooks Preview
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-198760-3b5540d7b8f4

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/entities-schema`	43	45	+2

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`home`	152.0KB	151.9KB	-39.0B
`inventory`	236.4KB	236.4KB	+34.0B
total			-5.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`inventory`	12.2KB	12.1KB	-58.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/entities-schema`	43	45	+2

History

💔 Build #250356 failed 21dd1a9
💔 Build #250259 failed a370ab3
💚 Build #249941 succeeded 38c7370
💚 Build #249875 succeeded 423b2a8
💚 Build #249840 succeeded ebf9c58

kibanamachine · 2024-11-12T17:47:22Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11802828881

kibanamachine · 2024-11-12T17:52:01Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts You might need to backport the following PRs to 8.x: - [Inventory][ECO] Use ControlGroupRenderer to filter by entity types (#199174)

Manual backport

To create the backport manually run:

node scripts/backport --pr 198760

Questions ?

Please refer to the Backport tool documentation

crespocarlos · 2024-11-13T10:22:42Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…lastic#198760) closes [elastic#198758](elastic#198758) ## Summary This PR removes the Entity type used across the Inventory and replaces it with `InventoryEntityLatest`, which provides strong typing for the latest entity object. This change makes the code leverage TypeScript’s intellisense and autocompletion in the editor, making the code easier to work with and more maintainable across the codebase. `InventoryEntityLatest` is the interface that the API returns and what the UI consumes. Note that this is distinct from the index mapping defined by `entityLatestSchema`, creating a separation layer between Elasticsearch and the UI. --------- Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: kibanamachine <[email protected]> (cherry picked from commit c4d3de8) # Conflicts: # x-pack/plugins/observability_solution/apm/ftr_e2e/cypress/e2e/transaction_details/transaction_details.cy.ts

…type (#198760) (#199967) # Backport This will backport the following commits from `main` to `8.x`: - [[Inventory][ECO] Replace `Entity` with `InventoryEntityLatest` type (#198760)](#198760)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

crespocarlos force-pushed the 196142-adjust-types branch 2 times, most recently from 222c45c to a597446 Compare November 4, 2024 16:41

crespocarlos added 4 commits November 4, 2024 17:42

Improve typing

ad95291

Improve types

99cd0d4

update type considering the latest changes

b23fae2

Adjust group by feature

8ba7131

crespocarlos force-pushed the 196142-adjust-types branch from a597446 to 8ba7131 Compare November 4, 2024 16:42

crespocarlos changed the title ~~[Inventory][ECO] Refactor entity type~~ [Inventory][ECO] Replace Entity with InventoryEntityLatest type Nov 4, 2024

crespocarlos commented Nov 4, 2024

View reviewed changes

...ugins/observability_solution/inventory/public/components/entities_grid/entity_name/index.tsx Outdated Show resolved Hide resolved

crespocarlos commented Nov 4, 2024

View reviewed changes

...ability_solution/inventory/public/components/grouped_inventory/inventory_group_accordion.tsx Outdated Show resolved Hide resolved

crespocarlos commented Nov 4, 2024

View reviewed changes

x-pack/plugins/observability_solution/inventory/server/routes/entities/get_entity_types.ts Outdated Show resolved Hide resolved

Fix imports

9321024

crespocarlos force-pushed the 196142-adjust-types branch from 4afe580 to 9321024 Compare November 4, 2024 17:12

crespocarlos added release_note:skip Skip the PR/issue when compiling release notes backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Nov 4, 2024

Create an inteface between API and UI independent from index mapping

5155dcf

crespocarlos commented Nov 5, 2024

View reviewed changes

Clean up

cb96542

Merge branch 'main' into 196142-adjust-types

b0d66b1

crespocarlos commented Nov 5, 2024

View reviewed changes

x-pack/plugins/observability_solution/inventory/public/hooks/use_detail_view_redirect.ts Outdated Show resolved Hide resolved

crespocarlos added 4 commits November 5, 2024 20:01

Missing change

bd28149

Fix tests and zod schema

0334bfc

Fix infra get_latest_entity

8a49c1c

Revert get_entity_types change

be5cc41

crespocarlos added 4 commits November 8, 2024 17:10

Clean up

b046148

Merge branch 'main' of github.com:elastic/kibana into 196142-adjust-t…

3f06d21

…ypes

Fix after merge

3ccdac2

Type fix

38ffdc2

elasticmachine and others added 2 commits November 11, 2024 09:20

Merge branch 'main' into 196142-adjust-types

ebf9c58

Replace API return type with InventoryEntity

423b2a8

cauemarcondes reviewed Nov 11, 2024

View reviewed changes

crespocarlos added 3 commits November 11, 2024 13:54

Rename type guard function

f087c7d

Fix after isEntityOfType was renamed

38c7370

Merge branch 'main' of github.com:elastic/kibana into 196142-adjust-t…

a370ab3

…ypes

cauemarcondes approved these changes Nov 12, 2024

View reviewed changes

miltonhultgren approved these changes Nov 12, 2024

View reviewed changes

crespocarlos added 2 commits November 12, 2024 13:58

Improve esql function type

535568b

Fix after merge

21dd1a9

Merge branch 'main' into 196142-adjust-types

3b5540d

crespocarlos merged commit c4d3de8 into elastic:main Nov 12, 2024
28 checks passed

crespocarlos deleted the 196142-adjust-types branch November 12, 2024 17:47

kibanamachine added the v9.0.0 label Nov 12, 2024

crespocarlos mentioned this pull request Nov 13, 2024

[8.x] [Inventory][ECO] Replace Entity with InventoryEntityLatest type (#198760) #199967

Merged

kibanamachine added the v8.17.0 label Nov 13, 2024

nickofthyme mentioned this pull request Nov 13, 2024

in 8.16.0, add APM data wizard on a clean Cloud cluster results in a Kibana exception (for both Elastic APM and OpenTelemetry). #199891

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Inventory][ECO] Replace `Entity` with `InventoryEntityLatest` type #198760

[Inventory][ECO] Replace `Entity` with `InventoryEntityLatest` type #198760

crespocarlos commented Nov 4, 2024 •

edited by kibanamachine

Loading

crespocarlos Nov 4, 2024 •

edited

Loading

crespocarlos Nov 4, 2024

miltonhultgren Nov 12, 2024

crespocarlos commented Nov 4, 2024

crespocarlos Nov 5, 2024 •

edited

Loading

crespocarlos commented Nov 5, 2024

crespocarlos commented Nov 5, 2024

elasticmachine commented Nov 8, 2024 •

edited

Loading

API count

crespocarlos commented Nov 11, 2024

cauemarcondes Nov 11, 2024

crespocarlos Nov 11, 2024

cauemarcondes left a comment

miltonhultgren left a comment

miltonhultgren Nov 12, 2024

crespocarlos commented Nov 12, 2024

elasticmachine commented Nov 12, 2024 •

edited

Loading

API count

kibanamachine commented Nov 12, 2024

kibanamachine commented Nov 12, 2024

crespocarlos commented Nov 13, 2024

	entity: Pick<EntityInstance['entity'], 'identity_fields'>;
	identityFields: IdentityFields;

[Inventory][ECO] Replace Entity with InventoryEntityLatest type #198760

[Inventory][ECO] Replace Entity with InventoryEntityLatest type #198760

Conversation

crespocarlos commented Nov 4, 2024 • edited by kibanamachine Loading

Summary

crespocarlos Nov 4, 2024 • edited Loading

Choose a reason for hiding this comment

crespocarlos Nov 4, 2024

Choose a reason for hiding this comment

miltonhultgren Nov 12, 2024

Choose a reason for hiding this comment

crespocarlos commented Nov 4, 2024

crespocarlos Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

crespocarlos commented Nov 5, 2024

crespocarlos commented Nov 5, 2024

elasticmachine commented Nov 8, 2024 • edited Loading

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

crespocarlos commented Nov 11, 2024

cauemarcondes Nov 11, 2024

Choose a reason for hiding this comment

crespocarlos Nov 11, 2024

Choose a reason for hiding this comment

cauemarcondes left a comment

Choose a reason for hiding this comment

miltonhultgren left a comment

Choose a reason for hiding this comment

miltonhultgren Nov 12, 2024

Choose a reason for hiding this comment

crespocarlos commented Nov 12, 2024

elasticmachine commented Nov 12, 2024 • edited Loading

💚 Build Succeeded

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

kibanamachine commented Nov 12, 2024

kibanamachine commented Nov 12, 2024

💔 All backports failed

Manual backport

Questions ?

crespocarlos commented Nov 13, 2024

💚 All backports created successfully

Questions ?

[Inventory][ECO] Replace `Entity` with `InventoryEntityLatest` type #198760

[Inventory][ECO] Replace `Entity` with `InventoryEntityLatest` type #198760

crespocarlos commented Nov 4, 2024 •

edited by kibanamachine

Loading

crespocarlos Nov 4, 2024 •

edited

Loading

crespocarlos Nov 5, 2024 •

edited

Loading

elasticmachine commented Nov 8, 2024 •

edited

Loading

elasticmachine commented Nov 12, 2024 •

edited

Loading