Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for @aws-sdk version 3 #325

Merged
merged 6 commits into from
Jul 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 86 additions & 52 deletions lib/Open/index.js
Original file line number Diff line number Diff line change
@@ -1,100 +1,134 @@
const fs = require('graceful-fs');
const directory = require('./directory');
const Stream = require('stream');
const fs = require("graceful-fs");
const directory = require("./directory");
const Stream = require("stream");

module.exports = {
buffer: function(buffer, options) {
buffer: function (buffer, options) {
const source = {
stream: function(offset, length) {
stream: function (offset, length) {
const stream = Stream.PassThrough();
const end = length ? offset + length : undefined;
stream.end(buffer.slice(offset, end));
return stream;
},
size: function() {
size: function () {
return Promise.resolve(buffer.length);
}
},
};
return directory(source, options);
},
file: function(filename, options) {
file: function (filename, options) {
const source = {
stream: function(start, length) {
stream: function (start, length) {
const end = length ? start + length : undefined;
return fs.createReadStream(filename, {start, end});
return fs.createReadStream(filename, { start, end });
},
size: function() {
return new Promise(function(resolve, reject) {
fs.stat(filename, function(err, d) {
if (err)
reject(err);
else
resolve(d.size);
size: function () {
return new Promise(function (resolve, reject) {
fs.stat(filename, function (err, d) {
if (err) reject(err);
else resolve(d.size);
});
});
}
},
};
return directory(source, options);
},

url: function(request, params, options) {
if (typeof params === 'string')
params = {url: params};
if (!params.url)
throw 'URL missing';
url: function (request, params, options) {
if (typeof params === "string") params = { url: params };
if (!params.url) throw "URL missing";
params.headers = params.headers || {};

const source = {
stream : function(offset, length) {
stream: function (offset, length) {
const options = Object.create(params);
const end = length ? offset + length : '';
const end = length ? offset + length : "";
options.headers = Object.create(params.headers);
options.headers.range = 'bytes='+offset+'-' + end;
options.headers.range = "bytes=" + offset + "-" + end;
return request(options);
},
size: function() {
return new Promise(function(resolve, reject) {
size: function () {
return new Promise(function (resolve, reject) {
const req = request(params);
req.on('response', function(d) {
req.abort();
if (!d.headers['content-length'])
reject(new Error('Missing content length header'));
else
resolve(d.headers['content-length']);
}).on('error', reject);
req
.on("response", function (d) {
req.abort();
if (!d.headers["content-length"])
reject(new Error("Missing content length header"));
else resolve(d.headers["content-length"]);
})
.on("error", reject);
});
}
},
};

return directory(source, options);
},

s3 : function(client, params, options) {
s3: function (client, params, options) {
const source = {
size: function() {
return new Promise(function(resolve, reject) {
client.headObject(params, function(err, d) {
if (err)
reject(err);
else
resolve(d.ContentLength);
size: function () {
return new Promise(function (resolve, reject) {
client.headObject(params, function (err, d) {
if (err) reject(err);
else resolve(d.ContentLength);
});
});
},
stream: function(offset, length) {
stream: function (offset, length) {
const d = {};
for (const key in params)
d[key] = params[key];
const end = length ? offset + length : '';
d.Range = 'bytes='+offset+'-' + end;
for (const key in params) d[key] = params[key];
const end = length ? offset + length : "";
d.Range = "bytes=" + offset + "-" + end;
return client.getObject(d).createReadStream();
}
},
};

return directory(source, options);
},
s3_v3: function (client, params, options) {
const {
GetObjectCommand,
HeadObjectCommand,
} = require("@aws-sdk/client-s3");

custom: function(source, options) {
const source = {
size: async () => {
const head = await client.send(
new HeadObjectCommand({
Bucket: params.Bucket,
Key: params.Key,
})
);

return head.ContentLength ?? 0;
},
alice-was-here marked this conversation as resolved.
Show resolved Hide resolved
stream: (offset, length) => {
const stream = Stream.PassThrough();
const end = length ? offset + length : "";
client
.send(
new GetObjectCommand({
Bucket: params.Bucket,
Key: params.Key,
Range: `bytes=${offset}-${end}`,
})
)
.then((response) => {
response.Body.pipe(stream);
})
.catch((error) => {
stream.emit("error", error);
});

return stream;
},
};

return directory(source, options);
},
custom: function (source, options) {
return directory(source, options);
}
},
};
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@
"tap": "^12.7.0",
"temp": ">= 0.4.0 < 1"
},
"optionalDependencies": {
"@aws-sdk/client-s3": "^3.0.0"
alice-was-here marked this conversation as resolved.
Show resolved Hide resolved
},
"directories": {
"example": "examples",
"test": "test"
Expand Down
Loading