[Documentation] Add AppGateServer Docs #200

h5law · 2023-11-19T14:58:58Z

Summary

Human Summary

This PR:

Introduces a first pass at the documentation for the appgateserver

AI Summary

Summary generated by Reviewpad on 23 Nov 23 19:32 UTC

This pull request includes changes to multiple files.

The file relay_fixtures_test.go has changes to the variables marshaledMinableRelaysHex and marshaledUnminableRelaysHex. These variables have been updated with new values.
The file server.go has changes to the function recordLocalToScalar. The error messages returned by this function have been formatted to provide more information about the types involved.
A new file server.md has been added to the package. It serves as comprehensive documentation for the AppGateServer component, covering various aspects of its usage and functionality.
The file synchronous.go in the pkg/relayer/proxy package has changes to the serveHTTP function. The changes involve using the relayRequest.Meta.SessionHeader on the relayResponse session header, along with an added log statement for debugging purposes.
The file diff also shows changes to the dependency versions in a separate file.

If you need further assistance, please let me know.

Issue

Fixes (in part) 159

Type of change

Select one or more:

Testing

Run all unit tests: make go_develop_and_test
Verify Localnet manually: See the instructions [here](TODO: add link to instructions)

Sanity Checklist

I have tested my changes using the available tooling
I have performed a self-review of my own code
I have commented my code, updated documentation and left TODOs throughout the codebase

* pokt/main: [Off-chain] feat: observable utils (#171) [Off-chain] refactor: `MapFn`s receive context arg (#170)

RelayerOption parameter

- Fixed helpers for localnet regenesis - Added an application & supplier to the genesis file - Initializing appMap & supplierMap in E2E tests - Add support for the app's codec (for unmarshaling responses) in E2E tests - Adding a placeholder for `e2e/tests/relay.feature` --- Co-authored-by: harry <[email protected]>

* refactor: `MapFn`s receive context arg * feat: add `MapExpand` observable operator * refactor: `RelayerSessionsManager` to be more reactive * chore: add godoc comment * chore: review feedback improvements * trigger CI

Co-authored-by: Daniel Olshansky <[email protected]>

* pokt/main: [Relayer] refactor: simplify `RelayerSessionsManager` (#169) [Test] First step for automated E2E Relay test (#167)

* pokt/main: [Proxy] chore: Use depinject for relayerProxy (#173) [Sessions] chore: Use depinject for sessions mgr construction (#175)

…ger`.

red-0ne

Left a few chage request and questions but this seems promising 👍

pkg/appgateserver/docs/server.md

red-0ne · 2023-11-20T09:52:34Z

pkg/appgateserver/docs/server.md

+
+### Rings
+
+Rings are created using the application's on-chain state. This includes a list


Suggested change

Rings are created using the application's on-chain state. This includes a list

Rings are created using the application's on-chain state. In gateway mode, this includes a list

This will always include the gateways, it depends on whether the application has delegated or not, but if it has and it starts its own appgateserver to self sign it will still have those in its ring

red-0ne · 2023-11-20T09:55:22Z

pkg/partials/partial.go

+	}
+	return partialRequest.GetMethodWeighting()
+}
+
 // partiallyUnmarshalRequest unmarshals the payload into a partial request
 // that contains only the fields necessary to generate an error response and
 // handle accounting for the request's method.
 func partiallyUnmarshalRequest(payloadBz []byte) (PartialPayload, error) {


Curious to know how the RPCType is inferred when we'll have more than one

Here will be sort of like a switch logic but instead but unmarshalling - the first example would fail if it was not a json request with at least one of those fields. If this is not the case we will get to the next type - once i have a better understanding of REST request format I will put it in it will make more sense how we add RPC types

The PartialPayload interface has a GetRPCType() method that returns the rpc type for the payload hardcoded, so all we need to do is the partial unmarshal and were good to go for accoutning and errors

Olshansk

@h5law Did not do a deep review, but left a few large overaching naming questions that'll have major diffs if we go down that path. Lmk wyt

@red-0ne PTAL as well

pkg/appgateserver/docs/server.md

proto/pocket/shared/service.proto

pkg/relayer/proxy/symmetric.go

Olshansk · 2023-11-21T03:54:00Z

pkg/relayer/proxy/symmetric.go

-func NewJSONRPCServer(
+// NewSymmetricServer creates a new HTTP server that listens for incoming relay
+// requests and forwards them to the supported proxied service endpoint.
+// It takes the serviceId, endpointUrl, and the main RelayerProxy as arguments


The types are already getting outdated (e.g. serviced is incorrect), so lets remove that and just focus on the goal of the comment

Little confused here - I renamed the method in the comment and havent touched the rest. What is outdated and how?

pkg/relayer/proxy/symmetric.go

pkg/partials/interface.go

pkg/appgateserver/docs/server.md

pkg/partials/types/rest.go

Olshansk

@h5law I can appreciate merging in PRs to make building on top of main easier, but I still have not had a chance to review pkg/appgateserver/docs/server.md (the documentation here), so I don't see a reason to rush it.

If there's code in this PR that we should get in ASAP, let's split it out.

Olshansk · 2023-12-05T04:49:16Z

@h5law Going to review this tomorrow. Thanks for the patience!

Olshansk · 2023-12-20T00:41:16Z

@h5law Does this need any updates?

Do you mind synching this with main after #252 is merged in and I'll re-review?

Olshansk · 2024-01-03T22:45:11Z

@h5law Are we going to pick this PR up again?

h5law · 2024-01-05T16:52:45Z

@Olshansk @red-0ne I will close this PR and create a new document as lots has changed since I originally made it.

bryanchriswhite and others added 30 commits November 9, 2023 14:41

refactor: MapFns receive context arg

29b9bdf

chore: add ForEach map shorthand operator

b6c9c71

chore: add /pkg/observable/filter

f257b46

chore: add /pkg/observable/logging

194cee5

chore: add /pkg/relayer/protocol

cca55c2

chore: add Miner interface

c666542

feat: add Miner implementation

ea8d848

test: Miner implementation

38329bb

chore: fix comment

d2f9cb4

chore: add godoc comments

d502b75

feat: Add Relayer struct

48cef80

Merge remote-tracking branch 'pokt/main' into issues/13/feat/miner

f85a381

* pokt/main: [Off-chain] feat: observable utils (#171) [Off-chain] refactor: `MapFn`s receive context arg (#170)

chore: Rename to RelayMiner

cba145e

chore: Rename relay miner file

c81c274

chore: Remove unused

0e38e7d

RelayerOption parameter

[Relayer] refactor: simplify RelayerSessionsManager (#169)

0e72490

* refactor: `MapFn`s receive context arg * feat: add `MapExpand` observable operator * refactor: `RelayerSessionsManager` to be more reactive * chore: add godoc comment * chore: review feedback improvements * trigger CI

chore: review feedback improvements

107f6dd

Co-authored-by: Daniel Olshansky <[email protected]>

chore: review feedback improvements

ccad087

Merge remote-tracking branch 'pokt/main' into issues/13/feat/miner

8737024

* pokt/main: [Relayer] refactor: simplify `RelayerSessionsManager` (#169) [Test] First step for automated E2E Relay test (#167)

chore: update start mining comment

e041472

fix: Update Miner interface

8cf0784

fix: import cycle & goimports

85a49b7

chore: review feedback improvements

0788e1d

chore: cleanup TODO_THIS_COMMIT comments

e6a558b

Merge branch 'main' into issues/13/feat/miner

d04ea2a

chore: improve var & func names for clarity and consistency

9c75b2c

Merge remote-tracking branch 'pokt/main' into issues/13/feat/miner

286e1b2

* pokt/main: [Proxy] chore: Use depinject for relayerProxy (#173) [Sessions] chore: Use depinject for sessions mgr construction (#175)

refactor: move claim/proof lifecycle concerns to `relayerSessionsMana…

a0ffe9d

…ger`.

chore: review feedback improvements

2019637

h5law added this to the Shannon TestNet milestone Nov 19, 2023

h5law requested review from red-0ne, bryanchriswhite and Olshansk November 19, 2023 14:58

h5law self-assigned this Nov 19, 2023

chore: s/nil/null/g json

20061e1

red-0ne reviewed Nov 20, 2023

View reviewed changes

Olshansk requested changes Nov 21, 2023

View reviewed changes

h5law added 9 commits November 22, 2023 15:25

feat: address comments and tidy partials

860219e

Merge branch 'main' into feat/json_rpc_structure

1f7f80b

Merge branch 'feat/json_rpc_structure' into feat/symmetric_protocols

14bb187

chore: address comments

b7ccc27

chore: add proto comment

1c8701f

Merge branch 'feat/json_rpc_structure' into feat/symmetric_protocols

3caafb7

chore: s/symmetric/synchronous/

464da62

chore: s/JSON-RPC/synchronous/

a78d259

Merge branch 'feat/json_rpc_structure' into feat/symmetric_protocols

5685f65

h5law requested review from Olshansk and red-0ne November 22, 2023 15:53

h5law changed the title ~~[AppGate | RelayProxy | Documentation] Add AppGateServer Docs and Update Naming of Servers~~ [Documentation] Add AppGateServer Docs Nov 22, 2023

Base automatically changed from feat/json_rpc_structure to main November 23, 2023 19:21

h5law added 2 commits November 23, 2023 19:31

Merge branch 'main' into feat/symmetric_protocols

d0b20f2

chore: merge fragments

5845cce

Olshansk requested changes Nov 27, 2023

View reviewed changes

h5law closed this Jan 5, 2024

red-0ne mentioned this pull request Jan 29, 2024

[Documentation] Document AppGateServer usage #352

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Documentation] Add AppGateServer Docs #200

[Documentation] Add AppGateServer Docs #200

h5law commented Nov 19, 2023 •

edited by reviewpad bot

Loading

red-0ne left a comment

red-0ne Nov 20, 2023

h5law Nov 22, 2023

red-0ne Nov 20, 2023

h5law Nov 20, 2023 •

edited

Loading

Olshansk left a comment

Olshansk Nov 21, 2023

h5law Nov 22, 2023

Olshansk left a comment

Olshansk commented Dec 5, 2023

Olshansk commented Dec 20, 2023

Olshansk commented Jan 3, 2024

h5law commented Jan 5, 2024


		### Rings

		Rings are created using the application's on-chain state. This includes a list

[Documentation] Add AppGateServer Docs #200

[Documentation] Add AppGateServer Docs #200

Conversation

h5law commented Nov 19, 2023 • edited by reviewpad bot Loading

Summary

Human Summary

AI Summary

Summary generated by Reviewpad on 23 Nov 23 19:32 UTC

Issue

Type of change

Testing

Sanity Checklist

red-0ne left a comment

Choose a reason for hiding this comment

red-0ne Nov 20, 2023

Choose a reason for hiding this comment

h5law Nov 22, 2023

Choose a reason for hiding this comment

red-0ne Nov 20, 2023

Choose a reason for hiding this comment

h5law Nov 20, 2023 • edited Loading

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk Nov 21, 2023

Choose a reason for hiding this comment

h5law Nov 22, 2023

Choose a reason for hiding this comment

Olshansk left a comment

Choose a reason for hiding this comment

Olshansk commented Dec 5, 2023

Olshansk commented Dec 20, 2023

Olshansk commented Jan 3, 2024

h5law commented Jan 5, 2024

h5law commented Nov 19, 2023 •

edited by reviewpad bot

Loading

h5law Nov 20, 2023 •

edited

Loading