PAIR-code / PAIR-code/deliberate-lab

bug: Experiment name slashes preserved in zip construction

Open Beginner friendly
#1,155 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
96
Forks
40
Avg merge
2d 11h
Merged PRs (30d)
20

Description

The "private experiment name" field for an experiment is used as a prefix to name files when constructing the zip that's downloaded from the "Download experiment data" button. If the private experiment name contains slashes, these are preserved in the zip creation, meaning the zip will have nested subdirectories.

For example, if you name your experiment FOO/BAR, then the zip file will be named FOO_BAR_data.zip, but the files inside will be FOO/BAR.json, FOO/BAR_Alerts.csv and so on.

Recommend applying the same slash replacement treatment to the files within the zip as to the zip itself.

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

Start at the zip-construction entry point used by the “Download experiment data” button and trace how the private experiment name becomes internal file names. Verify the archive with a name such as FOO/BAR; done means its files use the same slash-replaced prefix as the downloaded zip name, without creating nested directories.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.