将流传递给s3.upload()

时间:2016-05-20 00:15:02

标签: node.js amazon-web-services amazon-s3 node-streams

我目前正在使用名为s3-upload-stream的node.js插件将非常大的文件流式传输到Amazon S3。它使用了多部分API,并且在很大程度上它运行良好。

但是,这个模块显示了它的年龄,我已经不得不对它进行修改(作者也弃用了它)。今天我遇到了亚马逊的另一个问题,我真的想接受作者的推荐并开始使用官方的aws-sdk来完成我的上传。

BUT。

官方SDK似乎不支持管道s3.upload()。 s3.upload的本质是你必须将可读流作为参数传递给S3构造函数。

我有大约120多个用户代码模块进行各种文件处理,并且它们与输出的最终目的地无关。引擎向它们发送一个可管理的可写输出流,然后它们就会输出它。我不能给他们一个AWS.S3对象,并要求他们在其上调用upload()而不向所有模块添加代码。我使用s3-upload-stream的原因是因为它支持管道。

有没有办法让aws-sdk s3.upload()可以将流传输到?

11 个答案:

答案 0 :(得分:81)

使用node.js upload()流包裹S3 stream.PassThrough()函数。

以下是一个例子:

inputStream
  .pipe(uploadFromStream(s3));

function uploadFromStream(s3) {
  var pass = new stream.PassThrough();

  var params = {Bucket: BUCKET, Key: KEY, Body: pass};
  s3.upload(params, function(err, data) {
    console.log(err, data);
  });

  return pass;
}

答案 1 :(得分:31)

在接受的答案中,该功能在上传完成之前结束,因此,它不正确。下面的代码从可读流中正确管道。

Upload reference

async function uploadReadableStream(stream) {
  const params = {Bucket: bucket, Key: key, Body: stream};
  return s3.upload(params).promise();
}

async function upload() {
  const readable = getSomeReadableStream();
  const results = await uploadReadableStream(readable);
  console.log('upload complete', results);
}

您还可以更进一步,使用ManagedUpload输出进度信息:

const manager = s3.upload(params);
manager.on('httpUploadProgress', (progress) => {
  console.log('progress', progress) // { loaded: 4915, total: 192915, part: 1, key: 'foo.jpg' }
});

ManagedUpload reference

A list of available events

答案 2 :(得分:22)

有点迟到的答案,它可能有希望帮助别人。您可以返回可写流和承诺,这样您就可以在上传完成后获得响应数据。

const uploadStream = ({ Bucket, Key }) => {
  const s3 = new AWS.S3();
  const pass = new stream.PassThrough();
  return {
    writeStream: pass,
    promise: s3.upload({ Bucket, Key, Body: pass }).promise(),
  };
}

您可以按如下方式使用该功能:

const { writeStream, promise } = uploadStream({Bucket: 'yourbucket', Key: 'yourfile.mp4'});
const readStream = fs.createReadStream('/path/to/yourfile.mp4');

readStream.pipe(writeStream);
promise.then(console.log);

答案 3 :(得分:2)

类型脚本解决方案:
此示例使用:

import * as AWS from "aws-sdk";
import * as fsExtra from "fs-extra";
import * as zlib from "zlib";
import * as stream from "stream";

和异步功能:

public async saveFile(filePath: string, s3Bucket: AWS.S3, key: string, bucketName: string): Promise<boolean> { 

         const uploadStream = (S3: AWS.S3, Bucket: string, Key: string) => {
            const passT = new stream.PassThrough();
            return {
              writeStream: passT,
              promise: S3.upload({ Bucket, Key, Body: passT }).promise(),
            };
          };
        const { writeStream, promise } = uploadStream(s3Bucket, bucketName, key);
        fsExtra.createReadStream(filePath).pipe(writeStream);     //  NOTE: Addition You can compress to zip by  .pipe(zlib.createGzip()).pipe(writeStream)
        let output = true;
        await promise.catch((reason)=> { output = false; console.log(reason);});
        return output;
}

在类似以下位置调用此方法:

let result = await saveFileToS3(testFilePath, someS3Bucket, someKey, someBucketName);

答案 4 :(得分:2)

在其他答案之后,并使用针对Node.js的最新AWS开发工具包,由于s3 upload()函数使用await语法和S3的promise接受流,因此存在一个更简洁的解决方案:

non-negative

答案 5 :(得分:1)

如果它能够帮助我能够成功地从客户端流式传输到s3:

https://gist.github.com/mattlockyer/532291b6194f6d9ca40cb82564db9d2a

服务器端代码假设req是一个流对象,在我的情况下,它是从客户端发送的,并在标题中设置了文件信息。

const fileUploadStream = (req, res) => {
  //get "body" args from header
  const { id, fn } = JSON.parse(req.get('body'));
  const Key = id + '/' + fn; //upload to s3 folder "id" with filename === fn
  const params = {
    Key,
    Bucket: bucketName, //set somewhere
    Body: req, //req is a stream
  };
  s3.upload(params, (err, data) => {
    if (err) {
      res.send('Error Uploading Data: ' + JSON.stringify(err) + '\n' + JSON.stringify(err.stack));
    } else {
      res.send(Key);
    }
  });
};

是的,这违反了惯例,但是如果你看一下这个要点,它比我用multer,busboy等找到的任何东西都要清洁......

+1实用主义,感谢@SalehenRahman的帮助。

答案 6 :(得分:1)

对于那些抱怨当他们使用s3 api上传功能并且零字节文件最终出现在s3上的人(@ Radar155和@gabo)-我也遇到了这个问题。

创建第二个PassThrough流,并将所有数据从第一个流到第二个,并将引用传递到第二个到s3。您可以通过几种不同的方式来执行此操作-可能是一种肮脏的方式,即侦听第一个流上的“数据”事件,然后将相同的数据写入第二个流中-类似于“结束”事件,只需调用第二个流上的end函数。我不知道这是否是aws api中的错误,节点的版本或其他问题-但这对我来说可以解决此问题。

这是它的外观:

var PassThroughStream = require('stream').PassThrough;
var srcStream = new PassThroughStream();

var rstream = fs.createReadStream('Learning/stocktest.json');
var sameStream = rstream.pipe(srcStream);
// interesting note: (srcStream == sameStream) at this point
var destStream = new PassThroughStream();
// call your s3.upload function here - passing in the destStream as the Body parameter
srcStream.on('data', function (chunk) {
    destStream.write(chunk);
});

srcStream.on('end', function () {
    dataStream.end();
});

答案 7 :(得分:1)

没有一个答案对我有用,因为我想:

  • 插入s3.upload()
  • s3.upload()的结果放入另一个流

接受的答案不做后者。其他的依赖于promise api,在处理流管道时,它很麻烦。

这是我对接受的答案的修改。

const s3 = new S3();

function writeToS3({Key, Bucket}) {
  const Body = new stream.PassThrough();

  s3.upload({
    Body,
    Key,
    Bucket: process.env.adpBucket
  })
   .on('httpUploadProgress', progress => {
       console.log('progress', progress);
   })
   .send((err, data) => {
     if (err) {
       Body.destroy(err);
     } else {
       console.log(`File uploaded and available at ${data.Location}`);
       Body.destroy();
     }
  });

  return Body;
}

const pipeline = myReadableStream.pipe(writeToS3({Key, Bucket});

pipeline.on('close', () => {
  // upload finished, do something else
})
pipeline.on('error', () => {
  // upload wasn't successful. Handle it
})

答案 8 :(得分:0)

我正在使用KnexJS,使用其流API时遇到了问题。我终于解决了它,希望以下内容对某人有帮助。

const knexStream = knex.select('*').from('my_table').stream();
const passThroughStream = new stream.PassThrough();

knexStream.on('data', (chunk) => passThroughStream.write(JSON.stringify(chunk) + '\n'));
knexStream.on('end', () => passThroughStream.end());

const uploadResult = await s3
  .upload({
    Bucket: 'my-bucket',
    Key: 'stream-test.txt',
    Body: passThroughStream
  })
  .promise();

答案 9 :(得分:0)

上面最被接受的答案中要注意的一点是: 如果您使用的是类似管道的方法,则需要在函数中返回pass

fs.createReadStream(<filePath>).pipe(anyUploadFunction())

function anyUploadFunction () { 
 let pass = new stream.PassThrough();
 return pass // <- Returning this pass is important for the stream to understand where it needs to write to.
}

否则,它会静默地移至下一个而不会引发错误,或者会引发TypeError: dest.on is not a function的错误,具体取决于您编写函数的方式

答案 10 :(得分:-2)

如果您知道流的大小,可以使用https://developers.facebook.com/docs/graph-api/reference/v2.6/user/photos#Creating上传流,如下所示:

  s3Client.putObject('my-bucketname', 'my-objectname.ogg', stream, size, 'audio/ogg', function(e) {
    if (e) {
      return console.log(e)
    }
    console.log("Successfully uploaded the stream")
  })