chore: Swapping Postman with Bruno #2422
Conversation
✅ Deploy Preview for brilliant-pasca-3e80ec ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sabineschaller
changed the title
|
I am going to rename the "postman" subdirectory as soon as people are happy with this PR. |
There was a problem hiding this comment.
Looks awesome 🎉 thank you for this! Everything worked for me, after I figured out how to set clientPrivateKey in the secrets.
Writing down a few things for next PR to not forget:
- We should enable prettier to be able to prettify the scripts.js file
- We can remove the Postman github actions
- We should update the docs to replace any references to Postman
...ly locally/Peer-to-Peer Cross Currency Payment/Create Receiver -remote Incoming Payment-.bru
Outdated
Show resolved
Hide resolved
postman/collections/Interledger/Rafiki Admin APIs/Create Asset.bru
Outdated
Show resolved
Hide resolved
postman/collections/Interledger/Rafiki Admin APIs/Create Or Update Peer By Url.bru
Outdated
Show resolved
Hide resolved
sabineschaller
requested review from
melissahenderson and
hajjimo
as code owners
github-actions
bot
added
type: localenv
|
|
||
| 1. run `docker logs rafiki-cloud-nine-mock-ase-1` | ||
| 2. find the list of created wallet addresses | ||
| 3. copy the url of one of the wallet addresses | ||
| 4. set the url into `senderWalletAddress` postman variable in `Remote Environment` | ||
| 4. set the url as `senderWalletAddress` variable in the Bruno `Remote` environment |
There was a problem hiding this comment.
should we mention the clientPrivateKey step in here?
There was a problem hiding this comment.
Couldn't we just pre-configure it according to the instructions instead of having these instructions? If we're suggesting to use the remote environment with a local wallet address then maybe we should just change https://ilp.rafiki.money/d99f0eee to http://localhost:3000/accounts/gfranklin?
Or are we running bruno from some other context where we want to keep that remote wallet address as it is? Even still I imagine this use-case is basically the default.
I guess I'm also wondering why we want to point to the remote environment in the context of local development? I mean I get it in terms of integrating but for our development purposes why use remote?
I feel like these steps could basically be "load the collection from this path" and "select the local environment".
There was a problem hiding this comment.
Should we add an autopeering environment in the future?
There was a problem hiding this comment.
@sabineschaller that's a good idea 👍
localenv/README.md
Outdated
|
|
||
| The Open Payments APIs can be interacted with using the Postman collection ([Open Payments APIs](https://www.postman.com/interledger/workspace/interledger/folder/22855701-1b204bc1-c8e5-44d4-bab9-444d7204b15a?ctx=documentation) and [Open Payments Auth APIs](https://www.postman.com/interledger/workspace/interledger/folder/22855701-ae80b96d-4d25-42b9-94fa-8ed17f0e5ed9?ctx=documentation)). It is configured to use the default endpoints of the local environment. | ||
| The Open Payments APIs can be interacted with using the [Bruno collection](https://github.com/interledger/rafiki/main/bruno/collections/Interledger) and its ([Open Payments APIs](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/Open%20Payments%20APIs) and [Open Payments Auth APIs](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/Open%20Payments%20Auth%20APIs)). It is configured to use the default endpoints of the local environment. |
There was a problem hiding this comment.
When I look at this without all the green highlighted URLs, it reads like this: "The Open Payments APIs can be interacted with using the Bruno collection and its Open Payments APIs and Open Payments Auth APIs." Are you saying that Bruno has its own set of Open Payments APIs that can interact with some other set of Open Payments APIs? In short, it seems repetitive, but I'm not sure if that's intentional.
There was a problem hiding this comment.
Maybe "The Bruno collection can be used to interact with the Open Payments API and Open Payments Auth API"?
There was a problem hiding this comment.
I'm good with that description, but I think I asked @sabineschaller during the Rafiki work week whether these were all separate APIs or just a single Open Payments API and, I think she said single..? Sabine can you refresh my memory?
There was a problem hiding this comment.
Thank you for making me be more precise @melissahenderson
We technically have 3 Open Payments APIs now:
- resource server API
- auth server API
- wallet address API
I don't think we make the distinction between resource server and wallet address API in the collection yet, because we have not moved the wallet address to be hosted on its own server.
Nevertheless, I think the correct wording would be
The Open Payments APIs can be interacted with using the Bruno collection (resource server endpoints and auth server endpoints).
postman/collections/Interledger/Examples/Open Payments/Grant Request Incoming Payment.bru
Outdated
Show resolved
Hide resolved
sabineschaller
requested review from
BlairCurrey,
mkurapov and
melissahenderson
|
|
||
| The Examples folder in the Postman API collection includes an eCommerce (Open Payments) example that can be executed one by one. It | ||
| 1. load the collection into Bruno by clicking "Open Collection" | ||
| 2. navigating to `/rafiki/main/bruno/collections/Interledger` on your machine and |
There was a problem hiding this comment.
Should we call the collection "Rafiki" instead?
| 2. navigating to `/rafiki/main/bruno/collections/Interledger` on your machine and | ||
| 3. clicking "Open" | ||
| Furthermore, you need to either load the [Local Environment](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/environments/Local%20Playground.bru) or the [Remote Environment](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/environments/Remote.bru). |
There was a problem hiding this comment.
| 2. navigating to `/rafiki/main/bruno/collections/Interledger` on your machine and | |
| 3. clicking "Open" | |
| Furthermore, you need to either load the [Local Environment](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/environments/Local%20Playground.bru) or the [Remote Environment](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/environments/Remote.bru). | |
| 2. navigating to `/rafiki/bruno/collections/Interledger` on your machine and clicking "Open" | |
| 3. Furthermore, you need to either load the [Local Environment](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/environments/Local%20Playground.bru) or the [Remote Environment](https://github.com/interledger/rafiki/main/bruno/collections/Interledger/environments/Remote.bru). |
Should it be like this instead?
| @@ -0,0 +1,133 @@ | |||
| const fetch = require('node-fetch') | |||
There was a problem hiding this comment.
is there a way we can maybe have this file in the root folder so that we don't have the empty "scripts" folder in the collection?
| vars:secret [ | ||
| clientPrivateKey |
There was a problem hiding this comment.
is the consensus in the end to keep this secret, even on local playground?
There was a problem hiding this comment.
If so I think we still need to add some instruction on where to get it (didn't see this added anywhere in the latest commits). I'm still confused about that actually. I pulled the one from postman which worked, and I thought maybe I could generate a key and copy the base64 version from rafiki.money but that doesnt work. I suppose even if we hardcoded one that works (which I'm still a proponent of since its not actually sensitive and it reduces setup, but not gonna insist on it) we should have some documentation of where this comes from.
| 6. creates a quote on the sender's account | ||
| 7. requests a grant to create (and read) an outgoing payment on the sender's account | ||
| 8. creates an outgoing payment on the sender's account | ||
| 9. fetches the outgoing payment on the sender's account | ||
| 8. continues the grant request (via the interaction flow) |
There was a problem hiding this comment.
should we just say about copying over the interaction_ref?
What about changing the outgoing payment grant request altogether to not have a finish method, and just be able to call continue request without needing to enter the interaction_ref using the new polling method?
Co-authored-by: Max Kurapov <[email protected]>
|
Issue with outstanding discussion items: |
Changes proposed in this pull request
Context
Postman keeps giving us sync issues. Bruno's version control is pure git, the files are readable, the UI is good. No paid subscription required anymore.
Also, Bruno's scripting is more powerful. I've only made our old scripts work with Bruno but technically, the lambda function shouldn't be required anymore, since Bruno can import node packages. In a follow-up PR, I'll get rid of the lambda.
Checklist
fixes #number