H-2959, H-3368: Implement a Value data type and make all data types inherit from it

[TimDiekmann]

🌟 What is the purpose of this PR?

Every data type should inherit (directly or indirectly) from Value.

🚫 Blocked by

• H-2958: Support anyOf in type system #5232
• H-3354: Expand data types, introduce parents #5243
• H-3376: Infer data type IDs if only abstract parents exists #5272
• H-3375: Overhaul logic to detect inheritance depths for data types #5274

🔍 What does this change?

• Add a Value data type definitions:

   {
   	"$schema": "https://blockprotocol.org/types/modules/graph/0.3/schema/data-type",
   	"kind": "dataType",
   	"$id": "https://blockprotocol.org/@blockprotocol/types/data-type/value/v/1",
   	"title": "Value",
   	"description": "A value that can be stored in a graph",
   	"anyOf": [
   		{ "type": "null" },
   		{ "type": "boolean" },
   		{ "type": "number" },
   		{ "type": "string" },
   		{ "type": "array" },
   		{ "type": "object" }
   	]
   }

• Move cached external types from Node migration to the type fetcher. This is the natural flow for reading external types and the type fetcher can read the cached types to avoid going to well-known types. In comparison to the Node API migration this implies that the types may always be available if the type fetcher is running and there is no custom logic required to mimic fetching external types.
• Change existing primitive types to inherit from Value
• Change empty-list type to use items: false instead of const: []
• Remove const for array schemas
• Enforce a parent in data types (except for Value)

Pre-Merge Checklist 🚀

🚢 Has this modified a publishable library?

This PR:

• does not modify any publishable blocks or libraries, or modifications do not need publishing

📜 Does this require a change to the docs?

The changes in this PR:

• are internal and do not require a docs change

🕸️ Does this require a change to the Turbo Graph?

The changes in this PR:

• do not affect the execution graph

⚠️ Known issues

The production instance needs to be patched to read the new data

📹 Demo

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 20.23%. Comparing base (4f7aa39) to head (882b224).
Report is 118 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5240      +/-   ##
==========================================
+ Coverage   20.18%   20.23%   +0.04%     
==========================================
  Files         510      508       -2     
  Lines       17300    17260      -40     
  Branches     2546     2537       -9     
==========================================
  Hits         3492     3492              
+ Misses      13770    13730      -40     
  Partials       38       38              

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

[github-actions]

Benchmark results

@rust/graph-benches – Integrations

representative_read_multiple_entities

Function	Value	Mean	Flame graphs
entity_by_property	depths: DT=0, PT=2, ET=2, E=2	$$56.2 \mathrm{ms} \pm 512 \mathrm{μs}\left({\color{gray}1.46 \mathrm{\%}}\right) $$	Flame Graph
entity_by_property	depths: DT=0, PT=0, ET=2, E=2	$$51.7 \mathrm{ms} \pm 360 \mathrm{μs}\left({\color{gray}0.628 \mathrm{\%}}\right) $$	Flame Graph
entity_by_property	depths: DT=0, PT=0, ET=0, E=2	$$44.9 \mathrm{ms} \pm 242 \mathrm{μs}\left({\color{gray}-0.336 \mathrm{\%}}\right) $$	Flame Graph
entity_by_property	depths: DT=255, PT=255, ET=255, E=255	$$68.0 \mathrm{ms} \pm 271 \mathrm{μs}\left({\color{gray}-0.890 \mathrm{\%}}\right) $$	Flame Graph
entity_by_property	depths: DT=2, PT=2, ET=2, E=2	$$60.0 \mathrm{ms} \pm 412 \mathrm{μs}\left({\color{gray}-0.367 \mathrm{\%}}\right) $$	Flame Graph
entity_by_property	depths: DT=0, PT=0, ET=0, E=0	$$41.1 \mathrm{ms} \pm 218 \mathrm{μs}\left({\color{gray}-0.034 \mathrm{\%}}\right) $$	Flame Graph
link_by_source_by_property	depths: DT=0, PT=2, ET=2, E=2	$$94.4 \mathrm{ms} \pm 623 \mathrm{μs}\left({\color{gray}-0.896 \mathrm{\%}}\right) $$	Flame Graph
link_by_source_by_property	depths: DT=0, PT=0, ET=2, E=2	$$89.5 \mathrm{ms} \pm 527 \mathrm{μs}\left({\color{gray}-2.175 \mathrm{\%}}\right) $$	Flame Graph
link_by_source_by_property	depths: DT=0, PT=0, ET=0, E=2	$$83.4 \mathrm{ms} \pm 684 \mathrm{μs}\left({\color{gray}1.74 \mathrm{\%}}\right) $$	Flame Graph
link_by_source_by_property	depths: DT=255, PT=255, ET=255, E=255	$$107 \mathrm{ms} \pm 605 \mathrm{μs}\left({\color{gray}-0.889 \mathrm{\%}}\right) $$	Flame Graph
link_by_source_by_property	depths: DT=2, PT=2, ET=2, E=2	$$98.8 \mathrm{ms} \pm 442 \mathrm{μs}\left({\color{gray}-1.663 \mathrm{\%}}\right) $$	Flame Graph
link_by_source_by_property	depths: DT=0, PT=0, ET=0, E=0	$$43.9 \mathrm{ms} \pm 287 \mathrm{μs}\left({\color{gray}-0.172 \mathrm{\%}}\right) $$	Flame Graph

representative_read_entity

Function	Value	Mean	Flame graphs
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/uk-address/v/1	$$16.9 \mathrm{ms} \pm 223 \mathrm{μs}\left({\color{gray}1.36 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/building/v/1	$$16.1 \mathrm{ms} \pm 185 \mathrm{μs}\left({\color{lightgreen}-5.642 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/song/v/1	$$15.5 \mathrm{ms} \pm 194 \mathrm{μs}\left({\color{red}14.2 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/page/v/2	$$16.2 \mathrm{ms} \pm 205 \mathrm{μs}\left({\color{gray}0.625 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/person/v/1	$$15.6 \mathrm{ms} \pm 184 \mathrm{μs}\left({\color{lightgreen}-16.540 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/block/v/1	$$16.0 \mathrm{ms} \pm 167 \mathrm{μs}\left({\color{lightgreen}-10.108 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/book/v/1	$$15.7 \mathrm{ms} \pm 148 \mathrm{μs}\left({\color{lightgreen}-30.322 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/organization/v/1	$$17.2 \mathrm{ms} \pm 205 \mathrm{μs}\left({\color{red}11.7 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	entity type ID: https://blockprotocol.org/@alice/types/entity-type/playlist/v/1	$$18.6 \mathrm{ms} \pm 213 \mathrm{μs}\left({\color{red}17.8 \mathrm{\%}}\right) $$	Flame Graph

representative_read_entity_type

Function	Value	Mean	Flame graphs
get_entity_type_by_id	Account ID: d4e16033-c281-4cde-aa35-9085bf2e7579	$$1.41 \mathrm{ms} \pm 5.26 \mathrm{μs}\left({\color{gray}0.024 \mathrm{\%}}\right) $$	Flame Graph

scaling_read_entity_complete_zero_depth

Function	Value	Mean	Flame graphs
entity_by_id	10 entities	$$2.07 \mathrm{ms} \pm 22.2 \mathrm{μs}\left({\color{gray}2.62 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	25 entities	$$2.51 \mathrm{ms} \pm 8.85 \mathrm{μs}\left({\color{gray}-0.082 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	5 entities	$$1.90 \mathrm{ms} \pm 6.92 \mathrm{μs}\left({\color{gray}1.13 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	50 entities	$$4.09 \mathrm{ms} \pm 27.4 \mathrm{μs}\left({\color{gray}0.354 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	1 entities	$$1.87 \mathrm{ms} \pm 9.15 \mathrm{μs}\left({\color{gray}-0.178 \mathrm{\%}}\right) $$	Flame Graph

scaling_read_entity_complete_one_depth

Function	Value	Mean	Flame graphs
entity_by_id	10 entities	$$51.3 \mathrm{ms} \pm 312 \mathrm{μs}\left({\color{gray}4.05 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	25 entities	$$70.9 \mathrm{ms} \pm 463 \mathrm{μs}\left({\color{gray}-4.690 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	5 entities	$$24.6 \mathrm{ms} \pm 100 \mathrm{μs}\left({\color{gray}1.07 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	50 entities	$$273 \mathrm{ms} \pm 1.82 \mathrm{ms}\left({\color{gray}0.638 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	1 entities	$$19.7 \mathrm{ms} \pm 117 \mathrm{μs}\left({\color{gray}0.052 \mathrm{\%}}\right) $$	Flame Graph

scaling_read_entity_linkless

Function	Value	Mean	Flame graphs
entity_by_id	10000 entities	$$9.50 \mathrm{ms} \pm 163 \mathrm{μs}\left({\color{red}6.13 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	10 entities	$$1.85 \mathrm{ms} \pm 6.87 \mathrm{μs}\left({\color{gray}0.906 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	100 entities	$$2.02 \mathrm{ms} \pm 10.6 \mathrm{μs}\left({\color{gray}1.66 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	1000 entities	$$2.73 \mathrm{ms} \pm 22.0 \mathrm{μs}\left({\color{lightgreen}-6.830 \mathrm{\%}}\right) $$	Flame Graph
entity_by_id	1 entities	$$1.84 \mathrm{ms} \pm 5.09 \mathrm{μs}\left({\color{gray}-0.214 \mathrm{\%}}\right) $$	Flame Graph