Start Keploy server from Typescript-SDK #62

frey0-0 · 2023-03-09T21:18:46Z

Fixes #352
If the keploy mode is record and test then it will check if keploy is running on port 6789 and if it isn't then it will start an asynchronously process to start the keploy server and the server won't keeping running, it will stop the server as soon as the main app server stops

re-Tick · 2023-03-10T07:15:33Z

Hi @frey0-0, we should start the Keploy server from Keploy class constructor in src/keploy.ts because middleware is called on API call only. But we should check for Keploy binary during user API server setup.

frey0-0 · 2023-03-10T16:48:30Z

Yes that makes sense @re-Tick cause it may be possible the binary is not even present. I will look into this and mention if I have any issues here only. Thanks for the review 😄

frey0-0 · 2023-03-10T21:31:58Z

@re-Tick I have made the changes now we check if the keploy binary is present or not and next if it is running on port 6789 and if it is present and not running then it will spawn a process to start the server

re-Tick · 2023-03-12T17:36:37Z

Hi @frey0-0, I have tried these changes in my local but the keploy binary do not run from the spawn method call.

frey0-0 · 2023-03-12T21:46:17Z

the spawn method call will run the binary as long as the node server is running and it will be terminated if the node server is stopped because the parent process has stopped. Please have a look at this video below.

This is on my system which has the keploy binary installed
Screen Recording

This is a system which doesn't have the keploy binary

The keploy server stops if we stop the node server and can be started from the command again
Screen Recording

re-Tick · 2023-03-13T06:21:14Z

I have found an interesting issue due to which Keploy binary is trying to run on the same port as the sample API server. This is because Keploy runs on port defined by PORT env variable or 6789 (default).

So, we can solve this by changing the env variable name in keploy to "KPORT"

You can repklicate this by:

Use node-fetch sample of samples/typescript.
Add export PORT=8080 in the .env file of node-fetch.
Now, Change the env varibale name from KEPLOY_APP_PORT to PORT in this line of app.listen
Try recording some testcases.
Error will be thrown failed to post testcase to keploy server.

frey0-0 · 2023-03-13T14:20:24Z

Oh yes! I faced the same error and we should change the name of the Keploy Port. Should I add an issue and then raise a PR for this or directly raise a PR for this describing the issue for the variable name change?

frey0-0 · 2023-03-13T15:28:40Z

I have created an issue and also linked a PR for it. @re-Tick Please review it :) and are there any more changes that need to be done on this PR?

re-Tick · 2023-03-17T06:26:19Z

src/keploy.ts

+        } else {
+          exec("lsof -i:6789", (error, stdout, stderr) => {
+            if (!stdout) {
+              spawn("keploy");


Here, run the Keploy binary with KEPLOY_PORT=6789 env variable.

So I should use the command export KEPLOY_PORT=6789 before spawning the keploy binary right?

Yes, this export cmd can be run with keploy using && in the exec method

I have done the changes please have a look ✨

LGTM. Please rebase your commit messages for the github action to pass

I have made the changes to commit messages. I didn't know there was a specific way to write the commit messages. Thank you for being so patient 😅

Signed-off-by: Tanmay Bajaj <[email protected]>

* fix: stores correct http response for unique test-ids Signed-off-by: re-Tick <[email protected]> * feat(mongoose): adds hooks for mocking/stubbing mongoose methods Signed-off-by: re-Tick <[email protected]> * docs: updates the docs for mongoose and refactors Signed-off-by: re-Tick <[email protected]> * docs: refactors readme for e2e and mocks-lib docs Signed-off-by: re-Tick <[email protected]> * docs: adds require stmt in docs code snippet Signed-off-by: re-Tick <[email protected]> --------- Signed-off-by: re-Tick <[email protected]> Signed-off-by: Tanmay Bajaj <[email protected]>

Signed-off-by: Tanmay Bajaj <[email protected]>

Signed-off-by: re-Tick <[email protected]> Signed-off-by: Tanmay Bajaj <[email protected]>

the executionContext was getting undefined for mocking dependency call outputs Signed-off-by: re-Tick <[email protected]> Signed-off-by: Tanmay Bajaj <[email protected]>

Signed-off-by: Tanmay Bajaj <[email protected]>

re-Tick · 2023-03-26T17:42:58Z

LGTM. Please add the link in GSOC task list

frey0-0 mentioned this pull request Mar 9, 2023

[feature]: start Keploy server from Typescript-SDK keploy/keploy#352

Closed

1 task

This was referenced Mar 13, 2023

[bug]: Keploy server doesn't start if we use PORT env variable for our server keploy/keploy#469

Closed

update environment variable name for port of keploy server keploy/keploy#470

Closed

re-Tick requested a review from Sarthak160 March 15, 2023 11:36

re-Tick reviewed Mar 17, 2023

View reviewed changes

frey0-0 mentioned this pull request Mar 20, 2023

Changes in README.md to add PR link keploy/gsoc#45

Merged

frey0-0 force-pushed the start-sdk-keploy branch 2 times, most recently from 4073339 to 5dcf9a5 Compare March 22, 2023 18:28

frey0-0 and others added 8 commits March 23, 2023 00:00

fix(middleware): run keploy binary in middleware

0cc1e6e

Signed-off-by: Tanmay Bajaj <[email protected]>

feat(constructor): spawn keploy server if mode is test or record

985471b

Signed-off-by: Tanmay Bajaj <[email protected]>

fix(logs): remove unwanted logs

36da52c

Signed-off-by: Tanmay Bajaj <[email protected]>

docs: updates description for router/dependencies

bd6f02c

Signed-off-by: Tanmay Bajaj <[email protected]>

fix(express): checks for the valid resp in send (keploy#65)

5253ef9

Signed-off-by: re-Tick <[email protected]> Signed-off-by: Tanmay Bajaj <[email protected]>

fix(src/utils): adds ctx parameter in processDep (keploy#69)

0e74e44

the executionContext was getting undefined for mocking dependency call outputs Signed-off-by: re-Tick <[email protected]> Signed-off-by: Tanmay Bajaj <[email protected]>

fix: export KEPLOY_PORT while starting keploy server

8e4c07e

Signed-off-by: Tanmay Bajaj <[email protected]>

frey0-0 force-pushed the start-sdk-keploy branch from 946d18a to 8e4c07e Compare March 22, 2023 18:31

Merge branch 'main' into start-sdk-keploy

b0a5293

re-Tick added Don't Merge Not to be merged until gsoc results Accepted PR is reviewed and Accepted labels Mar 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Start Keploy server from Typescript-SDK #62

Start Keploy server from Typescript-SDK #62

frey0-0 commented Mar 9, 2023

re-Tick commented Mar 10, 2023

frey0-0 commented Mar 10, 2023

frey0-0 commented Mar 10, 2023

re-Tick commented Mar 12, 2023

frey0-0 commented Mar 12, 2023

re-Tick commented Mar 13, 2023

frey0-0 commented Mar 13, 2023

frey0-0 commented Mar 13, 2023 •

edited

Loading

re-Tick Mar 17, 2023

frey0-0 Mar 17, 2023

re-Tick Mar 19, 2023

frey0-0 Mar 20, 2023

re-Tick Mar 22, 2023

frey0-0 Mar 22, 2023

re-Tick commented Mar 26, 2023

Start Keploy server from Typescript-SDK #62

Are you sure you want to change the base?

Start Keploy server from Typescript-SDK #62

Conversation

frey0-0 commented Mar 9, 2023

re-Tick commented Mar 10, 2023

frey0-0 commented Mar 10, 2023

frey0-0 commented Mar 10, 2023

re-Tick commented Mar 12, 2023

frey0-0 commented Mar 12, 2023

re-Tick commented Mar 13, 2023

frey0-0 commented Mar 13, 2023

frey0-0 commented Mar 13, 2023 • edited Loading

re-Tick Mar 17, 2023

Choose a reason for hiding this comment

frey0-0 Mar 17, 2023

Choose a reason for hiding this comment

re-Tick Mar 19, 2023

Choose a reason for hiding this comment

frey0-0 Mar 20, 2023

Choose a reason for hiding this comment

re-Tick Mar 22, 2023

Choose a reason for hiding this comment

frey0-0 Mar 22, 2023

Choose a reason for hiding this comment

re-Tick commented Mar 26, 2023

frey0-0 commented Mar 13, 2023 •

edited

Loading