drive_v3 files.create unable to get resumable session URI

Open
  • Is something wrong?
#3,426 1 comment 1 reaction 0 assignees View on GitHub

Maintainers usually reply within 2 days

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
nodejs, typescript
Domain
api

Research direction

Start with the drive_v3 files.create definition in src/apis/drive/v3.ts and then inspect createAPIRequestAsync in the linked nodejs-googleapis-common src/apirequest.ts. Compare the request construction with the Drive resumable-upload documentation; done means files.create can obtain the resumable session URI through the specified uploadType without requiring a manual POST or rootUrl override.

Written by the indexing model from the issue text.

Description

api: drive priority: p3 type: feature request
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.

Dominant language
TypeScript
Stars
12.3k
Forks
2k
Avg merge
3d 10h
Merged PRs (30d)
9

Getting set up

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.

More from googleapis/google-api-nodejs-client

All issues in googleapis/google-api-nodejs-client

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.