[RFC] Starting the debugging API #562
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
They are far from clean, and not the current priority
I don't know why TS allows declaring an uninitialized variable (that is even read before written) with a type that does not admit undefined.
…s#439) following up on convo with Julien earlier today
It seems to be common for code to not need the context argument of reactiveCompute. This PR reorders the args so that when it is not needed, it can be omitted.
I am finding the name of the inputCollections field of SkipService confusing, and so propose a renaming. There are two aspects: the type of the field is not a Collection in the Skip sense, and the name inputCollections is also used for that actual collections argument of reactiveCompute. The reuse of the name is confusing, I think, as the field is the initial data while the argument is the working data of the service. Users should not ever read the inputCollections field, only provide it for runService (and eventually initService) to read. But users should read from the inputCollections argument. I think that renaming to emphasize that the field is only the initial data will help.
I am finding the name of the inputCollections field of SkipService confusing, and so propose a renaming. There are two aspects: the type of the field is not a Collection in the Skip sense, and the name inputCollections is also used for that actual collections argument of reactiveCompute. The reuse of the name is confusing, I think, as the field is the initial data while the argument is the working data of the service. Users should not ever read the inputCollections field, only provide it for runService (and eventually initService) to read. But users should read from the inputCollections argument. I think that renaming to emphasize that the field is only the initial data will help.
In expected usage, the reactive service will not know its own public URL, so this function does not make sense. This reverts commit 0f0bd4d.
In expected usage, the reactive service will not know its own public URL, so this function does not make sense. This reverts commit 0f0bd4d.
This class provides methods that mirror and have thin implementations over the skip service HTTP interface. This class is providing a method-call interface for the HTTP interface. In this context, the term "broker" seems more appropriate and clear.
…kipLabs#543) - Rename RESTWrapperOfSkipService to SkipServiceBroker This class provides methods that mirror and have thin implementations over the skip service HTTP interface. This class is providing a method-call interface for the HTTP interface. In this context, the term "broker" seems more appropriate and clear. - Document SkipServiceBroker
Noticed while documenting, the data returned by ServiceInstance.getArray will be an array of Json values.
Noticed while documenting, the data returned by ServiceInstance.getArray will be an array of Json values.
To match the interface of Eager/LazyCollection.
To match the interface of Eager/LazyCollection.
First attempt to describe SKStore. Still needs some work.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here is a start for a debugging API. You can test it like that:
cd skipruntime-ts bun run build bun run examples/groups.tscurl http://localhost:8081/v1/debug/raw/dirs | jqwhich gives me before.json
After running the example server and client, I get: after.json
Design discussion points:
/debug/raw/and SkipRuntime-level stuff under/debug/inputs/,/debug/resources/,/debug/streams/, what do you think?