googleapis / google-api-nodejs-client

Google's officially supported Node.js client library for accessing Google APIs. Support for authorization and authentication with OAuth 2.0, API Keys and JWT (Service Tokens) is included.
https://googleapis.dev/nodejs/googleapis/latest/
Apache License 2.0
11.26k stars 1.91k forks source link

drive_v3 files.create unable to get resumable session URI #3426

Open riccardomartinelli opened 5 months ago

riccardomartinelli commented 5 months ago

Feature

I think that would be nice to be able to get the resumable session URI by specifying the uploadType: 'resumable' parameters on the drive_v3 files.create method, instead of doing a POST request.

const params = {
  uploadType: 'resumable'
};

const options = {};

const res = await drive.files.create(params, options);
const uri = res.headers.location;

Motivation

Initially I thought that was the case by reading the documentation on how to perform a resumable upload (link). So I take a look at the code to understand how to do that but unfortunately it seems impossible.

To summarise the documentation to get a resumable URI we need to do a POST like so: POST https://www.googleapis.com/upload/drive/v3/files?uploadType=resumable

If we take a look at how the create method it's implemented we found out that we have this URI in to the mediaUrl attribute. (link)

If we take a look how the request it's constructed we found out that only when we have the media.body the correct url it's used. But then the uploadType it's changed in to something else. So the POST request can't be constructed as desired. (link)

Solution

In this case a first simple fix would be modify the createAPIRequestAsync of googleapis-common to add another if statement to enforce the right URI when we have an empty body and the uploadType is set to "resumable". Pretty much like so:

if (parameters.mediaUrl && media.body) {
  options.url = parameters.mediaUrl;
  if (resource) {
    params.uploadType = 'multipart';
    // more code
  } else {
    params.uploadType = 'media';
    // more code
  }
} else if (parameters.mediaUrl && params.uploadType === 'resumable') {
  options.url = parameters.mediaUrl;
} else {
  options.data = resource || undefined;
}

The current solution that I could find instead is to override the URI in the options like so:

 const options = {
  rootUrl: 'https://www.googleapis.com/upload'
};

Please let me know if i'm missing something or if I should proceed with a pull request on nodejs-googleapis-common repository.

MrSaints commented 3 months ago

I've encountered the exact same issue, the workaround to override the URI works for now.