interledger / interledger/rafiki

Prepare for Bruno v4 migration

Open Beginner friendly
#3,948 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
TypeScript
Stars
358
Forks
116
Avg merge
2d 21h
Merged PRs (30d)
4

Description

Context

The way that the Bruno client will handle variables will be changing in v4:

In v4 (to be released in 3rd week of July), scripts that modify environment and global variables will now automatically save those changes to disk.

If your scripts use these APIs to set tokens, credentials, or other secrets, those values will be written to disk and could be committed to git.

This means that we should replace all instances of bru.setEnvVar() to just bru.setVar() in our pre & post request Bruno scripts (bruno > collections > Rafiki), since typically we only want those variables to be set during the lifetime of the requests/session, and not for the whole environment.

See more: https://github.com/usebruno/bruno/discussions/8257

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the pre- and post-request Bruno scripts under bruno/collections/Rafiki for every bru.setEnvVar() call. Replace those calls with bru.setVar(), then verify that no bru.setEnvVar() instances remain in the collection scripts and that the requests still use session-scoped variables.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
84/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.