New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial event sourcing implementation #3869

Merged

awwaiid merged 26 commits into main from event-source

Oct 15, 2023

Collaborator

dorner commented Sep 4, 2023 •

edited

Loading

This PR shows how we might implement an event sourcing pattern.

The overall approach is as follows:

Single Table Inherited Event model with an organization_id.
Use dry-structs to model the payloads for the events.
Single "aggregate" service class to process events in order and result in an Inventory instance that indicates all inventory for all items across storage locations.
Pass a validate method into the event processing to indicate if we should apply business logic rules. By default we should only validate when the event is being created. Otherwise we might end up in a bad state when we change business logic rules after the fact.

Lots of next steps:

Implement a check when an event is being created (via validate: true)
Provide a method to check the aggregate against the current inventory for the organization
Integrate the check in some way (error on controller perhaps)
Notify (Slack?) when the check fails (i.e. "regular" model passes but the event source fails).

Once that's in place, we can leave it there for a while until we validate the quality of the data.

dorner added 16 commits

August 18, 2023 17:02


          event source wip

3be465f


          better?

4f05a29


          more better?

4281e9e


          Use our own models

2a542eb


          First draft of event source model

4ec9b68

wip

907c5ab


          Add audit and adjustment

ac1b77e

wip

425b97a


          wip wip wip

76d7fa9


          wip it good

b87c054


          weeeeeeeep

484ac85


          what is it? wip

7712f63


          nae nae

1c5f5c4


          woooooiip

a2058bd


          wip continues with a forecast of further wip


          Snapshot current organizations

21ae26c

dorner marked this pull request as ready for review

September 22, 2023 20:36


          Merge branch 'main' into event-source

47f5235

# Conflicts:
#	Gemfile
#	app/controllers/adjustments_controller.rb
#	app/services/adjustment_create_service.rb
#	db/schema.rb

awwaiid reviewed

View reviewed changes

app/controllers/audits_controller.rb

@@ @@ -40,6 +40,7 @@ def finalize @@
                   ActiveRecord::Base.transaction do
                     @audit.storage_location.increase_inventory increasing_adjustment
                     @audit.storage_location.decrease_inventory decreasing_adjustment
+                    AuditEvent.publish(@audit)

Collaborator

awwaiid Sep 24, 2023

I'm worried that the @audit.split_differences routine does weird things, should this event record be above the split_difference, or even higher up than that near the @audit.save?

Collaborator Author

dorner Sep 24, 2023

It's in a transaction, so it doesn't really matter. Either all of the records will be created or none of them will.

awwaiid reviewed

View reviewed changes

app/events/adjustment_event.rb Outdated

+                    event_time: Time.zone.now,
+                    data: EventTypes::InventoryPayload.new(
+                      items: EventTypes::EventLineItem.from_line_items(adjustment.line_items, to: adjustment.storage_location_id)
+                    ).as_json

Collaborator

awwaiid Sep 24, 2023

Why do some of these have .as_json and others don't?

Collaborator Author

dorner Sep 24, 2023

Which ones don't?

dorner added 3 commits

September 24, 2023 11:05


          Fix merge bug

45a9cbe


          Fix lint

4a22589


          Not using this

1b66459

dorner changed the title ~~Draft PR for event sourcing~~ Initial event sourcing implementation

dorner added 4 commits

September 29, 2023 16:25


          Fix specs

5fa9c78


          Create event on import

a9a5c2b


          Fix lint

c92944d


          grrrr

a334255

awwaiid reviewed

View reviewed changes

app/events/donation_destroy_event.rb Show resolved Hide resolved


          Remove unneeded as_json

7920d6b

awwaiid merged commit a0f48a9 into main

12 checks passed

awwaiid deleted the event-source branch

October 15, 2023 14:29

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

26 similar comments

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

Contributor

github-actions bot commented Oct 15, 2023

@dorner: Your PR/Issue Initial event sourcing implementation is part of today's Human Essentials production release: 2023.10.15.
Thank you very much for your contribution!

dorner mentioned this pull request

[BUG]: Auto-thanking has bugs #3910

Closed

2 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet