Dprof-in-tech
commented
1 month ago I am applying to this issue via OnlyDust platform.
My background and how it can be leveraged
Hello, i am Dprof-in-tech, an experienced Full Stack Blockchain Developer and I am excited to contribute my skills to this project in this ODHACK 8. With a strong background in Next.js, TypeScript, JavaScript, React, Node.js, Rust and Cairo, I've honed my technical skills across the blockchain development landscape.
My journey with OnlyDust began at Edition 2, and I've since made 34 contributions across 11 projects. This extensive experience on the platform has allowed me to develop a keen understanding of delivering high-quality solutions under tight deadlines. I bring a unique blend of technical prowess and user-centric design to every project, whether I'm crafting immersive 3D experiences or developing innovative smart contracts.
My track record demonstrates my ability to adapt quickly and contribute effectively to diverse challenges. I'm confident in my capacity to tackle new problems and drive innovation in the blockchain space. As we begin ODHACK 8, I'm eager to leverage my hackathon experience and technical skills to push the boundaries of what's possible in blockchain development.
Below is a link to my OnlyDust public profile. https://app.onlydust.com/u/Dprof-in-tech
How I plan on tackling this issue
Approach for Making Contract Client Timeouts Configurable:
-
Review Current Axios Implementation I will begin by reviewing the existing codebase, particularly where Axios is used to make contract client requests. This could involve reviewing the SDK initialization code and any utility files that handle network requests. The goal here is to identify how the current timeout setting is applied within Axios and where modifications can be made to allow this timeout to be configurable.
-
Add Configurable Timeout Option I will introduce an optional configuration parameter for the contract client SDK that allows users to set a custom timeout value for Axios requests. Specifically, I will: Modify the SDK initialization or the method where Axios is configured to accept a timeout parameter. This timeout parameter will allow users to set a custom timeout (in milliseconds) when initializing the SDK. If the timeout is not provided, it will default to a reasonable value (e.g., 30 seconds). The axios instance will then use this value when making API calls, giving developers more control over how long the client should wait for a response, especially on slow networks.
-
Modify Axios Configuration I will modify the Axios configuration within the SDK where network requests are made. This will involve: Passing the custom timeout value to the Axios instance using its timeout configuration option. If no timeout is specified by the user, I will ensure that the default value is used. I will also review the contract execution logic to make sure that the configurable timeout is applied consistently across different API calls (e.g., contract invocation, data fetching).
-
Error Handling Improvements I will improve the error handling mechanism for timeout errors: In cases where a request times out due to slow network conditions, a more informative error message will be thrown to inform the user that the operation failed due to a timeout. I will also include suggestions in the error message on how users can increase the timeout value to prevent the error in future requests. These error messages will be user-friendly and give clear instructions on how to adjust the timeout configuration.
-
Test the Timeout Configuration I will write tests to verify the behavior of the configurable timeout: I will simulate slow network conditions and verify that the timeout triggers as expected when using the default and custom values. Tests will cover multiple scenarios, such as: No timeout specified (should use default value). Custom timeout set by the user (ensures requests wait as long as the custom value allows). Network delays that cause requests to time out. I will also include tests to confirm that requests succeed if network delays do not exceed the configured timeout.
-
Update Documentation I will update the relevant documentation to include information on how to configure the contract client’s timeout settings. This will involve: Adding a section in the SDK’s documentation that explains how to pass a custom timeout value during initialization. Describing the default timeout behavior and how developers can configure it for different network environments.
-
Submit the Changes for Review After implementing the timeout configuration feature and completing testing: I will submit a pull request with the changes. This PR will include: Modifications to the Axios configuration in the SDK. New test cases that validate the custom timeout behavior. Documentation updates detailing how to configure the timeout. I will also request feedback from the project maintainers and address any comments or revisions.
-
Estimated Timeline Start Date: Immediately upon assignment. Estimated Completion Date: 3 days from the start date.
raizo07
Ugo-X
MullerTheScientist
martinvibes
petersdt
ShantelPeters
janewang
Shaptic
As per title. Right now I can't change axios timeouts and It throws exception on slow network. Currently, there's nothing you can do about it 😔 . Same contract code execution is working using cli, but throws axios timeout error with the SDK. Strangely, timeout seem to be very low (<1s) because invocation fails almost immediately.