node.jsgithubdownloadgithub-releaseprivate-repository

Download zip release from private repository with node.js

I'm trying to download zip release from a private repository, i've tried many solutions but none seems to work.

Here my code :

function Download(url, path, options) {
updateHeader(options.stageTitles.Downloading)
let received_bytes = 0;
let total_bytes = 0;

// eslint-disable-next-line
console.log('-----------------')
// eslint-disable-next-line
console.log(url, path)
console.log('-----------------')

var req = request(
    {
        method: 'GET',
        uri: url,
        headers: {
            Authorization: `token ${options.gitRepoToken}`,
            'Accept': 'application/octet-stream',
            'User-Agent': 'request module',
        },
        //encoding: null
    }
);

// eslint-disable-next-line
console.log(req)

var out = fs.createWriteStream(path);
req.pipe(out);

req.on('response', data => {
    // eslint-disable-next-line
    console.log(data.headers, data)
    total_bytes = parseInt(data.headers['content-length']);
});

req.on('data', chunk => {
    received_bytes += chunk.length;
    showProgress(received_bytes, total_bytes);
});

req.on('end', () => {
    Install(options)
});}

url variable equal something like : https://github.com/SolberLight/PRIVATE_REPO_NAME/releases/download/1.0/MY_ZIP_NAME.zip

Looks like I'm always getting a content size of 9 bytes with a "not found" response so I'm guessing that my headers aren't correct ?

thanks for your help !

EDIT 1 : Made some progress but now it seems that the blob is not the right size

 (async () => {
    //get latest release
    var response = await axios.get(
        `https://api.github.com/repos/${repoWithOwner}/releases/latest`,
        {
            headers: authHeaders,
        }
    );
    var assets = response.data.assets;
    for (var i = 0; i < assets.length; i++) {
        console.log(assets[i].url);
        response = await axios({
            method: "get",
            url: assets[i].url,
            responseType: "blob",
            headers: {
                //Accept: "application/octet-stream",
                ...authHeaders,
            },
        });
        // eslint-disable-next-line
        console.log(response.data, path)

        let reader = new FileReader()
        reader.onload = function() {
            if (reader.readyState == 2) {
                var buffer = new Buffer(reader.result)
                console.log(`Saving ${JSON.stringify({ fileName: 'myfile.zip', size: response.data.size })}`)
                outputFile(path, buffer, err => {
                    if (err) {
                        // eslint-disable-next-line
                        console.log(err.message)
                    } else {
                        // eslint-disable-next-line
                        console.log(path)
                    }
                })
            }
        }
        reader.readAsArrayBuffer(response.data)
    }
})();
Solution

  • You can use the Download repository archive (zip) endpoint, documented here

    Take into consideration the following:

    Check out the following working example:

    Download a zip release from GitHub                                                                                 View in Fusebit 
    const owner = 'stack-overflow-demos';

// For the purpose of this example, we have 1 release, so it will be always the first item.
const releases = await installationClient.rest.repos.listReleases({
  owner: 'stack-overflow-demos',
  repo: 'private-demo'
});

// Get release information (e.g zipball URL)
const release = await installationClient.rest.repos.getRelease({
  owner: 'stack-overflow-demos',
  repo: 'private-demo',
  release_id: releases.data[0].id,
});

const { token } = await installationClient.auth();

// According to official GitHub docs https://docs.github.com/en/rest/reference/repos#download-a-repository-archive-zip
// You will get a zipball URL you can use to download the zip file, you need to handle properly the redirects since a second GET
// request is needed, this time with an authenticated URL.
const { zipball_url, tag_name } = release.data;

const response = await getZipFile(zipball_url, token);

// Handle redirects properly if a responseUrl is returned that means you need to perform the redirect,
// you don't need to send the access token to this request, since is a signed URL
// Note: For private repositories, these links are temporary and expire after five minutes.
const {
  request: {
    res: { responseUrl },
  },
} = response;

if (responseUrl) {
  await downloadZipFile(responseUrl, `/tmp/'${tag_name}.zip`);
}

// Get information about the zip file you're about to download
const getZipFile = async (url, token) => {
  return await axios({
    redirect: 'manual',
    method: 'get',
    url,
    headers: {
      Authorization: `token ${token}`,
      Accept: 'application/vnd.github.v3+json',
    },
  });
};

// Download the zip file from the temporary secure URL returned from the first request
const downloadZipFile = async (url, filePath) => {
  const response = await axios({
    method: 'get',
    url,
    responseType: 'stream',
    headers: {
      Accept: 'application/octet-stream',
    },
  });

  return new Promise((resolve, reject) => {
    console.log(`writing to ${filePath}`);
    const dest = fs.createWriteStream(filePath);
    let progress = 0;
    response.data
      .on('end', () => {
        console.log('🎉 Done downloading file.');
        resolve(filePath);
      })
      .on('error', (err) => {
        console.error('🚫 Error downloading file.');
        reject(err);
      })
      .on('data', (d) => {
        progress += d.length;
        console.log(`🕛 Downloaded ${progress} bytes`);
      })
      .pipe(dest);
  });
};

    This example is using Octokit