@gillianomenezes your pull request is missing a changelog!

Hey @scanapi/core-team ,

Why this PR wasn't merged?

@hebertjulio because I did not have time to test it locally, to check if everything is working fine 😞
Do you wanna go ahead and test it? It would be awesome, I've been procrastinating this for a long time 😢

Of course @camilamaia , I can go ahead, we are here for help. 😄

Codecov Report

Merging #328 (c97cf61) into master (3e09a66) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master     #328      +/-   ##
==========================================
+ Coverage   95.87%   95.95%   +0.08%     
==========================================
  Files          22       22              
  Lines         678      693      +15     
==========================================
+ Hits          650      665      +15     
  Misses         28       28              

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3e09a66...c97cf61. Read the comment docs.

Hey,

I created a PR at examples repository to endpoint vars test.

scanapi/examples#27

Hey,

I created a PR at examples repository to endpoint vars test.

scanapi/examples#27

@hebertjulio Awesome!! It is the best way to go! Only one detail: we need to first merge this PR, and then the examples one, right? Because we have github action checks that use the examples repo, and it would break if these changes are not there yet. https://github.com/scanapi/scanapi/blob/master/.github/workflows/run-examples.yml

We could try to: . If everything works we:

• test this PR locally, using you example with vars in the endpoint
• if everything works -> merge this PR
• merge the example's pr

Does that make sense? What do you think?

Yes @camilamaia , that make full sense for me. Locally I tested both PR, but is always good idea that other dev test them too.

@hebertjulio I am testing it locally here and it seems we have some problems. If we try to access custom vars or env vars, it is not working.

In this line https://github.com/scanapi/examples/pull/27/files#diff-0db9b47343ca8e1c3f4eb61cfabd9a0cdd11862492fb6c72f63a0d512c1e0476R4, try to change it for

vars:  
  greeting: ${USER}

It is not replacing the value:

With python code, it works fine:

vars:
  greeting: ${{ "hello" + "!" }}

Probably it is not working for custom vars either...

Also, i've started asking myself if the values are really being replaced in the vars at the response level too:

#  demo-api/snippets.yaml

name: snippets
path: snippets/
vars:
  greeting: ${{ "hello" + "!" }}
headers:
  Authorization: Token ${token}
requests:
- name: create
  method: post
  body:
    title: Hello World
    code: "print('${greeting} world')"
    style: "xcode"
    language: "python"
  vars:
    snippet_id: ${{response.json()["id"]}}
    my_var_1: aloha! # THIS IS NEW
    my_var_2: ${USER} # THIS IS NEW
  tests:
    - ...
- name: details
  path: ${snippet_id}
  vars:
    my_var_3: ${my_var_1} # THIS IS NEW
  tests:
    - ...

- name: update_with_patch
  path: ${snippet_id}/?${my_var_2}&${my_var_3} # THIS IS NEW
  method: patch
  body:
    code: "print('${greeting}, patch')"
  tests:
    - ...
...

And the result is that we already have a problem... custom vars are not being replaced:

Maybe we could have all these scenarion in our demo-api example.... And also, of course, in the unit tests 🤔

Hey @scanapi/core-team ,

I found two possible problem in request_node.py.

1. The response from the previous request remains available before the new request is made. Maybe delete response in endpoint.vars before make new request be a good idea.

2. When endpoint.vars with response value handling, like ${{response.json()['id']}} is loaded, an error is thrown late because the response doesn't exist yet or is it a response from the previous request, without id item in json. I thought about creating a filter to remove those vars that handle response, or something like that. I accepted suggestions.

@hebertjulio great job! This is the core of the lib and you are getting familiar with it! It is amazing we have contributors who can discuss the core functions and how to solve this kind of problems 🤩 I love this stuff, I am super excited 🚀

For point 1, I like the idea of deleting the response every time, so the next flow would start clean. Maybe at the end of the RequestNode run method? Or did you think in another place?

About the point 2, in my opinion, the user should not be able to access response outside the request "level". Becaause, as you said, it is does not exist yet. We should raise a specific error saying that response does not exist outside the request.

What do you think?

@hebertjulio great job! This is the core of the lib and you are getting familiar with it! It is amazing we have contributors who can discuss the core functions and how to solve this kind of problems star_struck I love this stuff, I am super excited rocket

For point 1, I like the idea of deleting the response every time, so the next flow would start clean. Maybe at the end of the RequestNode run method? Or did you think in another place?

About the point 2, in my opinion, the user should not be able to access response outside the request "level". Becaause, as you said, it is does not exist yet. We should raise a specific error saying that response does not exist outside the request.

What do you think?

Hey @camilamaia , thanks for the encouragement! 😄

About point 1, deleting the response at the end of the RequestNode run method sounds good to me. Now, about point 2, raise a specific error is a excellent idea, but I think not resolve the current problem, because error occurs when I load vars before make request e when I call self.body, self.headers and self.params, the evaluate method is called and code evaluate is executed.

@hebertjulio hmm I am not sure I got the problem 🤔 Do you wanna pair to try to solve this together?

@hebertjulio hmm I am not sure I got the problem thinking Do you wanna pair to try to solve this together?

Yes, I wanna.

@hebertjulio awesome, let's do it via Discord!

@hebertjulio awesome, let's do it via Discord!

Weekdays I get home at 20:30.

Hey @camilamaia

Are Docstrings required in test functions? DeepSource is warning me about this.

Hey @camilamaia

Are Docstrings required in test functions? DeepSource is warning me about this.

No they aren't. Let me add a filter for it, 1 sec

@hebertjulio solved ✅