Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Record and Playback] Filling out README with instructions #4961

Closed
sophiajt opened this issue Sep 1, 2019 · 2 comments · Fixed by #5288
Closed

[Record and Playback] Filling out README with instructions #4961

sophiajt opened this issue Sep 1, 2019 · 2 comments · Fixed by #5288
Assignees
@sadasant
Labels
Client This issue points to a problem in the data-plane of the library.

Comments

@sophiajt
Copy link
Contributor

sophiajt commented Sep 1, 2019

The current record/playback package has a pretty simple README. Other folks would like to use this, too, so we could help them by adding more instructions. Some things that came to mind:

  • How to record
  • How to playback a test once you've recorded it
  • How to use the it from inside of rush
  • How to use the it from outside of rush
  • How and when tests will be written (or overwritten)
  • How to mark data as sensitive
  • What happens to sensitive data
  • What happens to delays, and how to avoid unnecessarily delaying during playback

I may be forgetting a few steps, so feel free to add more.
@sophiajt sophiajt added the Client This issue points to a problem in the data-plane of the library. label Sep 1, 2019
@HarshaNalluru
Copy link
Member

sdk/test-utils/recorder/GUIDELINES.md document discusses some of the points you've mentioned.

@sophiajt
Copy link
Contributor Author

sophiajt commented Sep 3, 2019

@HarshaNalluru - Ah okay. These instructions should be part of the README itself, so they can be easily found. If you want, you could but all the basic instructions in the README and then link from there to more advanced instructions in a separate markdown file.

@HarshaNalluru HarshaNalluru mentioned this issue Sep 16, 2019
Closed
62 tasks
@sadasant sadasant assigned sadasant and unassigned HarshaNalluru Sep 16, 2019
sadasant added a commit to sadasant/azure-sdk-for-js that referenced this issue Sep 27, 2019
@sadasant
[Common Recorder] Updated README
542f878 
Fixes Azure#4961
@sadasant sadasant mentioned this issue Sep 27, 2019
Merged
sadasant added a commit to sadasant/azure-sdk-for-js that referenced this issue Oct 2, 2019
@sadasant
[Common Recorder] Updated README
bf714bf 
Fixes Azure#4961
sadasant added a commit to sadasant/azure-sdk-for-js that referenced this issue Oct 2, 2019
@sadasant
[Common Recorder] Updated README
d764d7f 
Fixes Azure#4961
sadasant added a commit to sadasant/azure-sdk-for-js that referenced this issue Oct 3, 2019
@sadasant
[Common Recorder] Updated README
4dd6675 
Fixes Azure#4961
sadasant added a commit that referenced this issue Oct 4, 2019
@sadasant
[Common Recorder] Updated README (#5288)
f269b12 
Fixes #4961
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@sadasant sadasant

Labels
Client This issue points to a problem in the data-plane of the library.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Common Recorder] Updated README sadasant/azure-sdk-for-js
3 participants
@sadasant @sophiajt @HarshaNalluru