Split RpcResponse into RpcResponse and RpcTransportResponse

[lorisleiva]

This PR renames the current RpcResponse type to RpcTransportResponse and adds a new type definition for RpcResponse which is more consistent with the new RpcRequest definition (from the previous PR).

The benefit of this is that, when defining RpcResponseTransformers, we no longer need to worry about transformer both the json and text paths. Now, only the json path matter. However, if your transformer needs to affect how that JSON is initially parsed from a string, then the fromText function may be added to the RpcResponse object.

The slight annoyance is that, in order to achieve this, we need some weird deferred logic which may confuse people looking at the internals of the RPC proxy.

solana-web3.js/packages/rpc-spec/src/rpc.ts

Lines 87 to 98 in f7a09e2

	let response: RpcResponse<TResponse> = { json: () => transportResponse.json() };
	const rawResponse: RpcResponse<TResponse> = {
	json: async () => {
	if (response.fromText) {
	return response.fromText(await transportResponse.text()) as TResponse;
	} else {
	return await transportResponse.json();
	}
	},
	};
	response = responseTransformer ? responseTransformer(rawResponse, request) : rawResponse;
	return await response.json();

As you can see we need the final response object in order to define the rawResponse object which is then transformed into a response object. It works because the json function is called after all this is resolved but it's a bit weird to read.

---

Here are some diagrams illustrating the RPC changes made by this PR.

Current state

Proposed state

[changeset-bot]

🦋 Changeset detected

Latest commit: 37d2420

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[lorisleiva]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• Split RpcResponse into RpcResponse and RpcTransportResponse #3170 👈
• Add toPayload and toText optional functions to RpcRequest #3168
• Add more response transformers #3163
• Combine RpcResponseTransformer and RpcResponseTransformerFor #3162
• Add more request transformers #3161
• Refactor fix for issue 479 as a transformer #3160
• Add getDefaultCommitmentRequestTransformer helper #3159
• Use RpcRequestTransformer type parameter on request argument #3158
• Update RPC APIs to use new types #3150
• Move types outside of rpc-request file #3149
• Update RPC transports to use new types #3148
• Add new RpcRequest, RpcResponse types and their transformer types #3147
• Rename RpcRequest to RpcApiRequestPlan #3146
• Rename RpcResponse to RpcResponseData #3145
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @lorisleiva and the rest of your teammates on Graphite

[lorisleiva]

We've decided to take another approach on this.

[github-actions]

Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up.