Skip to content
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.

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

feat(ts-client): add persisted predicates and periodic health check #658

Merged
merged 10 commits into from
Oct 22, 2024

Conversation

rafaelcr
Copy link
Collaborator

@rafaelcr rafaelcr commented Oct 22, 2024

Upgrades TS client to new breaking change with updated schema treatments and unit tests.

Breaking changes

  • Instead of letting users define a predicate uuid by hand, it is now configured automatically by the client so users can only set the name and we can use that as a key to figure out if we had already registered a predicate before. This makes UUIDs be local to that running event observer and avoids collisions when pointing multiple observers to one single chainhook node.
  • Upgrades schema names and configuration options to better reflect what they do

Other features

  • Adds on-disk predicate persistence for registered predicates: saves to disk and recalls upon restarts
  • Adds a configurable health check to make sure on-disk predicates are still healthy, and re-registers them if they are interrupted
  • Adds unit tests for new behavior

@rafaelcr rafaelcr marked this pull request as ready for review October 22, 2024 03:34
await this.fastify.listen({ host: this.observer.hostname, port: this.observer.port });
if (this.observer.predicate_health_check_interval_ms && this.healthCheckTimer === undefined) {
this.healthCheckTimer = setInterval(() => {
void predicateHealthCheck(this.observer, this.chainhook);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can predicateHealthCheck ever throw? If so, this needs a .catch(err => log(err)) otherwise could end up with an unhandled promise rejection

Copy link
Member

@zone117x zone117x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks robust 💯

@rafaelcr rafaelcr merged commit 535226a into develop Oct 22, 2024
10 of 12 checks passed
@rafaelcr rafaelcr deleted the fix/client-predicate-persist branch October 22, 2024 14:07
github-actions bot pushed a commit that referenced this pull request Oct 25, 2024
## [1.9.0-stacks-signers.1](v1.8.0...v1.9.0-stacks-signers.1) (2024-10-25)

### Features

* add various new nakamoto block fields to `/new_block` ingestion and `StacksPayload` ([#659](#659)) ([f48cda5](f48cda5))
* include recovered signer pubkeys in new block payload ([#662](#662)) ([b5ad4ba](b5ad4ba))
* include signer messages in Stacks predicate payloads ([#656](#656)) ([aee14bc](aee14bc))
* parse `/stackerdb_chunks` Stacks node event ([#653](#653)) ([e44d84a](e44d84a))
* store signer messages in local sqlite database ([#664](#664)) ([d12acd9](d12acd9))
* support tenure-height in block messages ([#661](#661)) ([99e5a61](99e5a61))
* **ts-client:** add persisted predicates and periodic health check ([#658](#658)) ([535226a](535226a))
* **ts-client:** add signer messages to stacks payloads ([#657](#657)) ([ff66bb2](ff66bb2))

### Bug Fixes

* add a configurable max timeout for outgoing predicate payload requests ([#642](#642)) ([6c1dfa9](6c1dfa9)), closes [#643](#643)
* increase stacks event server body size limit to 500MB ([#660](#660)) ([21234c9](21234c9))
* return 500 status code to Stacks node when event ingestion fails ([#648](#648)) ([63c753c](63c753c)), closes [#646](#646)
* signer pubkey calculation ([#665](#665)) ([cc93873](cc93873))
* update SignerMessage deserializing ([#663](#663)) ([71364c1](71364c1))
* validate ts client predicates before registering ([#639](#639)) ([2d08f72](2d08f72))
Copy link

🎉 This PR is included in version 1.9.0-stacks-signers.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Successfully merging this pull request may close these issues.

2 participants