GitHub archives cannot be downloaded if there is a tag and a branch with the same name

eg. when loading "v1.0.2" from https://github.com/gmalecha/mirror-core which has both a tag and a branch with that name:

https://sentry.softwareheritage.org/organizations/swh/issues/104637/?referrer=phabricator_plugin

ReadError: file could not be opened successfully:
- method gz: ReadError('not a gzip file')
- method bz2: ReadError('not a bzip2 file')
- method xz: ReadError('not an lzma file')
- method tar: ReadError('truncated header')
  File "shutil.py", line 1201, in _unpack_tarfile
    tarobj = tarfile.open(filename)
  File "tarfile.py", line 1629, in open
    raise ReadError(f"file could not be opened successfully:\n{error_msgs_summary}")

ReadError: /tmp/tmpbg1djs3i/v1.0.2.tar.gz is not a compressed or uncompressed tar file
  File "swh/core/tarball.py", line 161, in uncompress
    shutil.unpack_archive(tarpath, extract_dir=dest, format=format)
  File "shutil.py", line 1264, in unpack_archive
    func(filename, extract_dir, **dict(format_info[2]))
  File "shutil.py", line 1203, in _unpack_tarfile
    raise ReadError(

ValueError: Problem during unpacking /tmp/tmpbg1djs3i/v1.0.2.tar.gz. Reason: /tmp/tmpbg1djs3i/v1.0.2.tar.gz is not a compressed or uncompressed tar file
  File "swh/loader/package/loader.py", line 649, in load
    res = self._load_release(p_info, origin)
  File "swh/loader/package/loader.py", line 824, in _load_release
    (uncompressed_path, directory) = self._load_directory(dl_artifacts, tmpdir)
  File "swh/loader/package/loader.py", line 787, in _load_directory
    uncompressed_path = self.uncompress(dl_artifacts, dest=tmpdir)
  File "swh/loader/package/loader.py", line 424, in uncompress
    uncompress(a_path, dest=uncompressed_path)
  File "swh/core/tarball.py", line 163, in uncompress
    raise ValueError(f"Problem during unpacking {tarpath}. Reason: {e}")

---

Migrated from T4566 (view on Phabricator)

assigned to @vlorentz

unassigned @vlorentz

added priority:Low label

Reported to GitHub: https://support.github.com/ticket/personal/0/1811507

Answer from Github:

On 28/09/2022 14:38, GitHub Developer Support wrote:

Please do not write below this line

Your request (Ticket 1811507) has been updated.

To review the status of your request and add additional comments, please visit: Ticket 1811507.

---

GitHub Support, Sep 28, 2022, 12:38 PM UTC

Hi Val,

Thanks for writing in!

Indeed this happens when there's two refs - branch and tag - with the same name:

• Tag: https://github.com/gmalecha/mirror-core/releases/tag/v1.0.2
• Branch: https://github.com/gmalecha/mirror-core/tree/v1.0.2

To avoid such failures, you'll want to disambiguate the URL from the generic https://github.com/vertcoin-project/vertcoin-core/archive/0.18.0.zip to:

• Tag archive: https://github.com/gmalecha/mirror-core/archive/refs/tags/v1.0.2.tar.gz
• Tree archive: https://github.com/gmalecha/mirror-core/archive/refs/heads/v1.0.2.tar.gz

I hope this helps clarify! Please do let me know if you have any other questions about this!

Regards, Peter GitHub Support

---

Val Lorentz, Sep 27, 2022, 7:56 AM UTC

Description

Hi,

downloading from https://github.com/gmalecha/mirror-core/archive/v1.0.2.tar.gz returns HTTP 300 ("Multiple Choices") and the given path has multiple possibilities: #<Git::Ref:0x00007f74f4438378>, #<Git::Ref:0x00007f74f4438e90> as body

This happens because https://github.com/gmalecha/mirror-core has a tag and a branch, both named v1.0.2.

Reproduction Steps

 $ curl -i https://github.com/gmalecha/mirror-core/archive/v1.0.2.tar.gz
 HTTP/2 300
 server: GitHub.com
 date: Tue, 27 Sep 2022 07:53:32 GMT
 content-type: text/plain; charset=utf-8
 vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, Accept-Encoding, Accept, X-Requested-With
 cache-control: no-cache
 strict-transport-security: max-age=31536000; includeSubdomains; preload
 x-frame-options: deny
 x-content-type-options: nosniff
 x-xss-protection: 0
 referrer-policy: no-referrer-when-downgrade
 expect-ct: max-age=2592000, report-uri="https://api.github.com/_private/browser/errors"
 content-length: 105
 x-github-request-id: 9F28:FD0F:2EA462B:2FE26F3:6332ABFC

 the given path has multiple possibilities: #<Git::Ref:0x00007f74f4438378>, #<Git::Ref:0x00007f74f4438e90>

Fault Type

Permanent - Se produisant de manière répétitive

Blocking?

No

Last working date

Logs

---

This email is a service from GitHub Support.

[09EY9Q-3DYPR]