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.

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

feat: Add OpenRPC API docs and associated JSON Schemas #534

Merged
merged 78 commits into from
Feb 13, 2024
Merged

feat: Add OpenRPC API docs and associated JSON Schemas #534

merged 78 commits into from
Feb 13, 2024

Conversation

bgins
Copy link
Contributor

@bgins bgins commented Jan 26, 2024 •
edited
Loading

Description

This pull request includes the following features:

  • Add OpenRPC API document and JSON schema generator
    • Generate schemas in CI
  • Add OpenRPC API document
    • Add document
    • Add rpc.discover endpoint for service discovery
  • Add JSON Schemas
    • Workflow schema
    • Receipt schema
    • Receipt notification schema
    • Health check schema
    • Node info schema
    • Metrics schema
    • Network notifications
  • Refactor network notifications with structs to better support JSON Schemas
  • Add rendezvous and mDNS network notifications
    • Update discovery tests to use notifications instead of timeouts
  • Convert event cache to async implementation
  • Update pre-commit hook to allow no newline at the end of JSON files
  • Add subscribe_network_events test utility
  • Update dependabot_pr GitHub action check for modified files

Link to issue

Closes #449

Type of change

  • New feature (non-breaking change that adds functionality)
  • Refactor (non-breaking change that updates existing functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update (document the OpenRPC API, API discovery endpoint, and schemas in README)
  • Comments have been added/updated

The network notifications and node info response contain breaking changes for Control Panel.

Test plan (required)

The following test suites were added or updated:

  • Refactored network notification tests
  • OpenRPC discover endpoint test
  • Separated out node info test
  • Refactored Rendezvous, mDNS, and connection tests to rely on new notifications
  • Consolidated rendezvous connect and disconnect tests
  • Consolidated mDNS connect and disconnect tests
  • Consolidated connection and disconnection tests

@bgins bgins added the dx Developer experience applications and improvements label Jan 26, 2024
@bgins bgins force-pushed the bgins/schemas-and-api-docs branch from d3d4c04 to f73fb9f Compare January 29, 2024 17:38
bgins and others added 26 commits February 1, 2024 08:49
@bgins
feat: Add TaggedSchema trait
d1c7b95 
Adds a tag as a const field to a schema.
@bgins
feat: Add OpenRPC document generator
aa93468
@bgins
feat: Add API and schema generator
42e560c
@bgins
feat: Add health schema
e07dca5
@bgins
refactor: Remove internal tagging
c2d1a21
@bgins
feat: Add initial network notification implementations
a648159
@bgins
feat: Add OpenRPC x-messages extension
5eb7318
@bgins
feat: Add health API method
0e55222
@bgins
chore: Add IPLD schema generator
d0cb604
@bgins
chore: Update import
ef12a0b
@bgins
feat: Add workflow schema
9b88f19
@bgins
chore: Add network event emitter
6b8e09e
@bgins
feat: Add receipt and receipt notification schemas
7a905d6
@bgins
refactor: Add NodeInfo struct
111d7eb
@bgins
feat: Add node info schema
be9ec07
@bgins
feat: Add unsubscribe API methods
bb5bcd3
@bgins
feat: Add metrics schema
8b7c687
@bgins
chore: Set homestar as default binary
674c44b
@bgins
test: Add network notification testing apparatus
e134d7f
@bgins
test: Fix nodeinfo test
9e0c53b
@bgins
feat: Add mDNS discovered notification
66f2b76 
Update tests to use notifications instead of timeouts
@bgins
wip: Add rendezvous discovery notifications
b6de6f8
@zeeshanlakhani @bgins
spawn + cache
cebd548
@bgins
wip: More work on discovery notifications
9001e97
@zeeshanlakhani @bgins
async cache
448f379
@bgins
feat: Finish discovery notifications, schemas, and test upgrades
86de5ed
@bgins bgins force-pushed the bgins/schemas-and-api-docs branch from 11daf53 to 86de5ed Compare February 1, 2024 17:10
@bgins bgins marked this pull request as ready for review February 9, 2024 00:40
@bgins bgins requested a review from a team as a code owner February 9, 2024 00:40
zeeshanlakhani
zeeshanlakhani reviewed Feb 12, 2024
View reviewed changes
Cargo.toml Outdated Show resolved Hide resolved
homestar-invocation/src/authority/issuer.rs Show resolved Hide resolved
homestar-invocation/src/authority/issuer.rs Outdated Show resolved Hide resolved
homestar-invocation/src/receipt.rs Show resolved Hide resolved
homestar-invocation/src/task/config.rs Show resolved Hide resolved
homestar-invocation/src/task/instruction/nonce.rs Show resolved Hide resolved
homestar-runtime/src/event_handler/notification/network.rs Outdated Show resolved Hide resolved
homestar-runtime/src/event_handler/notification/network.rs Show resolved Hide resolved
homestar-runtime/src/event_handler/notification/network.rs Show resolved Hide resolved
zeeshanlakhani
zeeshanlakhani approved these changes Feb 12, 2024
View reviewed changes
Copy link
Contributor

@zeeshanlakhani zeeshanlakhani left a comment

Choose a reason for hiding this comment

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

One small comment out there for a quick fix, then let's get this in. @bgins don't forget to open up that follow-up issue. Otherwise, great, great work.

@bgins bgins force-pushed the bgins/schemas-and-api-docs branch from 5f3eaa8 to eaf66b1 Compare February 13, 2024 17:24
@bgins bgins force-pushed the bgins/schemas-and-api-docs branch from eaf66b1 to 590135a Compare February 13, 2024 17:38
@bgins bgins merged commit a82d01d into main Feb 13, 2024
33 checks passed
@bgins bgins deleted the bgins/schemas-and-api-docs branch February 13, 2024 18:04
@release-plz-ipvm-wg release-plz-ipvm-wg bot mentioned this pull request Feb 8, 2024
Merged
zeeshanlakhani pushed a commit that referenced this pull request Feb 21, 2024
@release-plz-ipvm-wg
chore: release (#527)
3c7c56a 
## 🤖 New release
* `homestar-runtime`: 0.1.1 -> 0.2.0 (⚠️ API breaking changes)
* `homestar-invocation`: 0.1.1 -> 0.2.0 (✓ API compatible changes)
* `homestar-wasm`: 0.1.1 -> 0.2.0 (✓ API compatible changes)
* `homestar-workflow`: 0.1.1 -> 0.2.0 (✓ API compatible changes)

### ⚠️ `homestar-runtime` breaking changes

```
--- failure enum_variant_added: enum variant added on exhaustive enum ---

Description:
A publicly-visible enum without #[non_exhaustive] has a new variant.
        ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new
       impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.28.0/src/lints/enum_variant_added.ron

Failed in:
  variant Command:Node in /tmp/.tmp7PLiiL/homestar/homestar-runtime/src/cli.rs:149
  variant Command:Info in /tmp/.tmp7PLiiL/homestar/homestar-runtime/src/cli.rs:155
```

<details><summary><i><b>Changelog</b></i></summary><p>

## `homestar-runtime`
<blockquote>

##
[0.2.0](homestar-runtime-v0.1.1...homestar-runtime-v0.2.0)
- 2024-02-20

### Added
- Add OpenRPC API docs and associated JSON Schemas
([#534](#534))
- redial `node_addresses` at an interval on connection close
([#529](#529))

### Fixed
- add handling of dns multiaddrs + bootstrapping + CLI / Conn changes
([#547](#547))

### Other
- deps + flake cleanup
([#581](#581))
- Allow dead code default timeout
([#577](#577))
- Update homestar-functions to use cargo component
([#576](#576))
- fix transport order for wss possibility
([#563](#563))
- small comment, sorry
([#561](#561))
- move away from deadlines dealing w/ the runner and wasi-preview 2
wasmtime ([#560](#560))
- docker updates with info command and rpc host update
([#558](#558))
- just test conn ([#544](#544))
- handle this evil workflow_info test
([#543](#543))
- remove unnecessary deps and add tooling for those checks
([#541](#541))
- [chore(cargo)](deps): bump puffin from 0.18.1 to 0.19.0
([#537](#537))
- updates/flaky kills on ci
([#540](#540))
- release docs and cp readmes
([#530](#530))
- port selection and test config generation macro
([#528](#528))
- [chore(cargo)](deps): bump serde_with from 3.4.0 to 3.5.0
([#524](#524))
- [chore(cargo)](deps): bump moka from 0.12.3 to 0.12.4
([#525](#525))
</blockquote>

## `homestar-invocation`
<blockquote>

##
[0.2.0](homestar-invocation-v0.1.1...homestar-invocation-v0.2.0)
- 2024-02-20

### Added
- Add OpenRPC API docs and associated JSON Schemas
([#534](#534))

### Other
- deps + flake cleanup
([#581](#581))
- Update homestar-functions to use cargo component
([#576](#576))
- move away from deadlines dealing w/ the runner and wasi-preview 2
wasmtime ([#560](#560))
- remove unnecessary deps and add tooling for those checks
([#541](#541))
- release docs and cp readmes
([#530](#530))
</blockquote>

## `homestar-wasm`
<blockquote>

##
[0.2.0](homestar-wasm-v0.1.1...homestar-wasm-v0.2.0)
- 2024-02-20

### Other
- deps + flake cleanup
([#581](#581))
- Update homestar-functions to use cargo component
([#576](#576))
- move away from deadlines dealing w/ the runner and wasi-preview 2
wasmtime ([#560](#560))
- remove unnecessary deps and add tooling for those checks
([#541](#541))
- release docs and cp readmes
([#530](#530))
</blockquote>

## `homestar-workflow`
<blockquote>

##
[0.2.0](homestar-workflow-v0.1.1...homestar-workflow-v0.2.0)
- 2024-02-20

### Added
- Add OpenRPC API docs and associated JSON Schemas
([#534](#534))

### Other
- deps + flake cleanup
([#581](#581))
- remove unnecessary deps and add tooling for those checks
([#541](#541))
- release docs and cp readmes
([#530](#530))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

Signed-off-by: release-plz-ipvm-wg[bot] <144082651+release-plz-ipvm-wg[bot]@users.noreply.github.com>
Co-authored-by: release-plz-ipvm-wg[bot] <144082651+release-plz-ipvm-wg[bot]@users.noreply.github.com>
@release-plz-ipvm-wg release-plz-ipvm-wg bot mentioned this pull request Feb 21, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zeeshanlakhani zeeshanlakhani zeeshanlakhani approved these changes

Assignees
No one assigned
Labels
dx Developer experience applications and improvements
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

JSON Schema/OpenRPC documentation for JSON RPC API
2 participants
@bgins @zeeshanlakhani