Entity state api #662

johnshaughnessy · 2023-01-20T23:03:06Z

Add Entities and SubEntities.

Each Entity is composed of:

A create_message, which tells clients how to spawn the entity (hierarchy) in the game world, and
Many SubEntities, which tell the client how to configure the components of spawned sub-entities.

Four Entity-related apis are added to the HubChannel:

name	permission	notes
`list_entities`	none
`save_entity_state`	`pin_objects`	Fails (gracefully) if an `Entity` (for the given `nid`) already exists
`update_entity_state`	`pin_objects`	Fails (gracefully) if an `Entity` (for the given `root_nid`) does not already exist
`delete_entity_state`	`pin_objects`	Fails (gracefully) if an `Entity` (for the given `nid`) does not already exist

Clients refer to Entities (and SubEntities) via nids, which are shared, client-generated string IDs.

Clients only care about the embedded CreateMessages (of Entities) and UpdateMessages (of SubEntities), so EntityView returns this data exclusively.

Client changes: Hubs-Foundation/hubs#5904

bryanenders

I’m having trouble following this schema design; let’s chat. This could also use some tests.

lib/ret_web/channels/hub_channel.ex

lib/ret/entity_state/create_message.ex

lib/ret/entity_state/update_message.ex

priv/repo/migrations/20230129061701_add_entity_create_messages_table.exs

priv/repo/migrations/20230129061719_add_entity_update_messages_table.exs

lib/ret_web/channels/hub_channel.ex

bryanenders · 2023-02-10T13:52:47Z

lib/ret/entity_manager.ex

+      fn %{entity: entity} ->
+        Enum.map(updates, &SubEntity.for_bulk_insert(hub, entity, &1))
+      end
+    )


I’m fairly certain this whole create_entity/2 function is achievable with a single Repo.insert/1 sans the Multi. Ecto.Changeset.cast_assoc/3 is the key. We can chat.

lib/ret_web/channels/hub_channel.ex

lib/ret/entity_state/create_message.ex

bryanenders · 2023-02-10T14:04:32Z

This is looking really good! It’s almost there!

https://hexdocs.pm/ecto_sql/Ecto.Migration.html#references/2

bryanenders

test/ret_web/channels/entity_test.exs

johnshaughnessy mentioned this pull request Jan 20, 2023

Entity state persistence Hubs-Foundation/hubs#5904

Merged

johnshaughnessy had a problem deploying to hc-bio January 20, 2023 23:06 — with GitHub Actions Failure

johnshaughnessy had a problem deploying to hc-bio January 20, 2023 23:53 — with GitHub Actions Failure

johnshaughnessy force-pushed the feature/message-store branch from 102c8c9 to 0129f44 Compare January 20, 2023 23:57

johnshaughnessy had a problem deploying to hc-bio January 21, 2023 00:01 — with GitHub Actions Failure

johnshaughnessy had a problem deploying to hc-bio January 22, 2023 03:51 — with GitHub Actions Failure

johnshaughnessy had a problem deploying to hc-bio January 22, 2023 03:56 — with GitHub Actions Failure

johnshaughnessy force-pushed the feature/message-store branch 2 times, most recently from 7467842 to 741a23e Compare January 23, 2023 03:33

johnshaughnessy had a problem deploying to hc-bio January 23, 2023 03:38 — with GitHub Actions Failure

johnshaughnessy force-pushed the feature/message-store branch from 741a23e to 861d99e Compare January 28, 2023 23:30

johnshaughnessy had a problem deploying to hc-bio January 28, 2023 23:34 — with GitHub Actions Failure

johnshaughnessy force-pushed the feature/message-store branch from 861d99e to 35c2294 Compare January 29, 2023 06:06

johnshaughnessy changed the base branch from master to upgrade-elixir January 29, 2023 06:06

johnshaughnessy had a problem deploying to hc-bio January 29, 2023 06:11 — with GitHub Actions Failure

johnshaughnessy had a problem deploying to hc-bio January 29, 2023 20:28 — with GitHub Actions Failure

johnshaughnessy force-pushed the feature/message-store branch 2 times, most recently from bb4b8f0 to 96f686c Compare January 29, 2023 20:40

johnshaughnessy had a problem deploying to hc-bio January 29, 2023 20:45 — with GitHub Actions Failure

johnshaughnessy force-pushed the feature/message-store branch from 96f686c to d02cd25 Compare January 31, 2023 07:28

johnshaughnessy had a problem deploying to hc-bio January 31, 2023 07:33 — with GitHub Actions Failure

johnshaughnessy changed the title ~~WIP New way to save entity states~~ Entity state api Jan 31, 2023

johnshaughnessy force-pushed the feature/message-store branch from d02cd25 to c659378 Compare January 31, 2023 16:17

johnshaughnessy marked this pull request as ready for review January 31, 2023 16:17

johnshaughnessy had a problem deploying to hc-bio January 31, 2023 16:24 — with GitHub Actions Failure

johnshaughnessy requested a review from bryanenders January 31, 2023 17:03

johnshaughnessy force-pushed the feature/message-store branch from c659378 to de4377f Compare January 31, 2023 17:47

johnshaughnessy had a problem deploying to hc-bio January 31, 2023 17:53 — with GitHub Actions Failure

Base automatically changed from upgrade-elixir to master February 1, 2023 16:30

bryanenders reviewed Feb 2, 2023

View reviewed changes

johnshaughnessy force-pushed the feature/message-store branch 2 times, most recently from 360bdf7 to f836e24 Compare February 10, 2023 06:13

bryanenders reviewed Feb 10, 2023

View reviewed changes

johnshaughnessy added 10 commits February 27, 2023 18:39

Add entity state api

95300f4

Add simpler CRUD api for entity state

a982901

Remove unused first attempt at entity states

c3f83c1

Message binaries are non nullable

6d7f8f6

[Rename] attrs -> params

cc1d4c6

Poison -> Jason

d78753f

Use on_delete option of references

52e8f2a

https://hexdocs.pm/ecto_sql/Ecto.Migration.html#references/2

[Rename] Entity and SubEntity

754b10f

Cleanup entity state functions

d047a8d

&parse/1

9477943

johnshaughnessy force-pushed the feature/message-store branch from f836e24 to 9477943 Compare February 27, 2023 23:39

johnshaughnessy temporarily deployed to smoke February 27, 2023 23:43 — with GitHub Actions Inactive

johnshaughnessy had a problem deploying to hc-bio February 27, 2023 23:43 — with GitHub Actions Failure

johnshaughnessy temporarily deployed to smoke February 28, 2023 02:13 — with GitHub Actions Inactive

johnshaughnessy had a problem deploying to hc-bio February 28, 2023 02:13 — with GitHub Actions Failure

Add entity tests

77a67cb

johnshaughnessy force-pushed the feature/message-store branch from ff02aa4 to 77a67cb Compare February 28, 2023 02:20

johnshaughnessy had a problem deploying to hc-bio February 28, 2023 02:25 — with GitHub Actions Failure

johnshaughnessy temporarily deployed to smoke February 28, 2023 02:25 — with GitHub Actions Inactive

bryanenders approved these changes Feb 28, 2023

View reviewed changes

test/ret_web/channels/entity_test.exs Outdated Show resolved Hide resolved

test/ret_web/channels/entity_test.exs Outdated Show resolved Hide resolved

johnshaughnessy added 2 commits February 28, 2023 19:29

Use pipeline

c2654bb

Read json files once, at compile time

28904b4

johnshaughnessy temporarily deployed to smoke March 1, 2023 00:59 — with GitHub Actions Inactive

johnshaughnessy had a problem deploying to hc-bio March 1, 2023 00:59 — with GitHub Actions Failure

johnshaughnessy merged commit 07918f8 into master Mar 1, 2023

johnshaughnessy deleted the feature/message-store branch March 1, 2023 01:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Entity state api #662

Entity state api #662

johnshaughnessy commented Jan 20, 2023 •

edited

Loading

bryanenders left a comment

bryanenders Feb 10, 2023

bryanenders commented Feb 10, 2023

bryanenders left a comment

Entity state api #662

Entity state api #662

Conversation

johnshaughnessy commented Jan 20, 2023 • edited Loading

bryanenders left a comment

Choose a reason for hiding this comment

bryanenders Feb 10, 2023

Choose a reason for hiding this comment

bryanenders commented Feb 10, 2023

bryanenders left a comment

Choose a reason for hiding this comment

johnshaughnessy commented Jan 20, 2023 •

edited

Loading