@uppy/google-photos: add plugin (#5265)

Backport of #5061

packages/@uppy/companion/src/config/grant.js

@@ -1,19 +1,34 @@
+const google = {
+  transport: 'session',
+
+  // access_type: offline is needed in order to get refresh tokens.
+  // prompt: 'consent' is needed because sometimes a user will get stuck in an authenticated state where we will
+  // receive no refresh tokens from them. This seems to be happen when running on different subdomains.
+  // therefore to be safe that we always get refresh tokens, we set this.
+  // https://stackoverflow.com/questions/10827920/not-receiving-google-oauth-refresh-token/65108513#65108513
+  custom_params: { access_type : 'offline', prompt: 'consent' },
+
+  // copied from https://github.com/simov/grant/blob/master/config/oauth.json
+  "authorize_url": "https://accounts.google.com/o/oauth2/v2/auth",
+  "access_url": "https://oauth2.googleapis.com/token",
+  "oauth": 2,
+  "scope_delimiter": " "
+}
+
 // oauth configuration for provider services that are used.
 module.exports = () => {
   return {
-    // for drive
-    google: {
-      transport: 'session',
-      scope: [
-        'https://www.googleapis.com/auth/drive.readonly',
-      ],
+    // we need separate auth providers because scopes are different,
+    // and because it would be a too big rewrite to allow reuse of the same provider.
+    googledrive: {
+      ...google,
       callback: '/drive/callback',
-      // access_type: offline is needed in order to get refresh tokens.
-      // prompt: 'consent' is needed because sometimes a user will get stuck in an authenticated state where we will
-      // receive no refresh tokens from them. This seems to be happen when running on different subdomains.
-      // therefore to be safe that we always get refresh tokens, we set this.
-      // https://stackoverflow.com/questions/10827920/not-receiving-google-oauth-refresh-token/65108513#65108513
-      custom_params: { access_type : 'offline', prompt: 'consent' },
+      scope: ['https://www.googleapis.com/auth/drive.readonly'],
+    },
+    googlephotos: {
+      ...google,
+      callback: '/googlephotos/callback',
+      scope: ['https://www.googleapis.com/auth/photoslibrary.readonly', 'https://www.googleapis.com/auth/userinfo.email'], // if name is needed, then add https://www.googleapis.com/auth/userinfo.profile too
     },
     dropbox: {
       transport: 'session',

packages/@uppy/companion/src/server/controllers/get.js

@@ -11,10 +11,7 @@ async function get (req, res) {
     return provider.size({ id, token: accessToken, query: req.query })
   }
 
-  async function download () {
-    const { stream } = await provider.download({ id, token: accessToken, providerUserSession, query: req.query })
-    return stream
-  }
+  const download = () => provider.download({ id, token: accessToken, providerUserSession, query: req.query })
 
   try {
     await startDownUpload({ req, res, getSize, download })

packages/@uppy/companion/src/server/controllers/url.js

@@ -25,8 +25,8 @@ const downloadURL = async (url, allowLocalIPs, traceId) => {
   try {
     const protectedGot = await getProtectedGot({ allowLocalIPs })
     const stream = protectedGot.stream.get(url, { responseType: 'json' })
-    await prepareStream(stream)
-    return stream
+    const { size } = await prepareStream(stream)
+    return { stream, size }
   } catch (err) {
     logger.error(err, 'controller.url.download.error', traceId)
     throw err
@@ -77,9 +77,7 @@ const get = async (req, res) => {
     return size
   }
 
-  async function download () {
-    return downloadURL(req.body.url, allowLocalUrls, req.id)
-  }
+  const download = () => downloadURL(req.body.url, allowLocalUrls, req.id)
 
   try {
     await startDownUpload({ req, res, getSize, download })

packages/@uppy/companion/src/server/helpers/oauth-state.js

@@ -6,7 +6,7 @@ module.exports.encodeState = (state, secret) => {
   return encrypt(encodedState, secret)
 }
 
-const decodeState = (state, secret) => {
+module.exports.decodeState = (state, secret) => {
   const encodedState = decrypt(state, secret)
   return JSON.parse(atob(encodedState))
 }
@@ -18,7 +18,7 @@ module.exports.generateState = () => {
 }
 
 module.exports.getFromState = (state, name, secret) => {
-  return decodeState(state, secret)[name]
+  return module.exports.decodeState(state, secret)[name]
 }
 
 module.exports.getGrantDynamicFromRequest = (req) => {

packages/@uppy/companion/src/server/helpers/upload.js

@@ -4,15 +4,23 @@ const { respondWithError } = require('../provider/error')
 
 async function startDownUpload({ req, res, getSize, download }) {
   try {
-    const size = await getSize()
+    logger.debug('Starting download stream.', null, req.id)
+    const { stream, size: maybeSize } = await download()
+
+    let size
+    // if the provider already knows the size, we can use that
+    if (typeof maybeSize === 'number' && !Number.isNaN(maybeSize) && maybeSize > 0) {
+      size = maybeSize
+    }
+    // if not we need to get the size
+    if (size == null) {
+      size = await getSize()
+    }
     const { clientSocketConnectTimeout } = req.companion.options
 
     logger.debug('Instantiating uploader.', null, req.id)
     const uploader = new Uploader(Uploader.reqToOptions(req, size))
 
-    logger.debug('Starting download stream.', null, req.id)
-    const stream = await download()
-
       // "Forking" off the upload operation to background, so we can return the http request:
       ; (async () => {
         // wait till the client has connected to the socket, before starting

packages/@uppy/companion/src/server/helpers/utils.js

@@ -165,11 +165,14 @@ module.exports.StreamHttpJsonError = StreamHttpJsonError
 
 module.exports.prepareStream = async (stream) => new Promise((resolve, reject) => {
   stream
-    .on('response', () => {
+    .on('response', (response) => {
+      const contentLengthStr = response.headers['content-length']
+      const contentLength = parseInt(contentLengthStr, 10);
+      const size = !Number.isNaN(contentLength) && contentLength >= 0 ? contentLength : undefined;
       // Don't allow any more data to flow yet.
       // https://github.com/request/request/issues/1990#issuecomment-184712275
       stream.pause()
-      resolve()
+      resolve({ size })
     })
     .on('error', (err) => {
       // In this case the error object is not a normal GOT HTTPError where json is already parsed,