Skip to content

S3 Improvements #738

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

Merged
merged 3 commits into from
Mar 1, 2016
Merged
Show file tree
Hide file tree
Changes from all 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
40 changes: 22 additions & 18 deletions spec/FilesController.spec.js
Original file line number Diff line number Diff line change
@@ -1,29 +1,33 @@
var FilesController = require('../src/Controllers/FilesController').FilesController;
var GridStoreAdapter = require("../src/Adapters/Files/GridStoreAdapter").GridStoreAdapter;
var S3Adapter = require("../src/Adapters/Files/S3Adapter").S3Adapter;
var Config = require("../src/Config");

var FCTestFactory = require("./FilesControllerTestFactory");


// Small additional tests to improve overall coverage
describe("FilesController",()=>{

it("should properly expand objects", (done) => {
var config = new Config(Parse.applicationId);
var adapter = new GridStoreAdapter();
var filesController = new FilesController(adapter);
var result = filesController.expandFilesInObject(config, function(){});
// Test the grid store adapter
var gridStoreAdapter = new GridStoreAdapter('mongodb://localhost:27017/parse');
FCTestFactory.testAdapter("GridStoreAdapter", gridStoreAdapter);

if (process.env.S3_ACCESS_KEY && process.env.S3_SECRET_KEY) {

// Test the S3 Adapter
var s3Adapter = new S3Adapter(process.env.S3_ACCESS_KEY, process.env.S3_SECRET_KEY, 'parse.server.tests');

expect(result).toBeUndefined();
FCTestFactory.testAdapter("S3Adapter",s3Adapter);

var fullFile = {
type: '__type',
url: "http://an.url"
}
// Test S3 with direct access
var s3DirectAccessAdapter = new S3Adapter(process.env.S3_ACCESS_KEY, process.env.S3_SECRET_KEY, 'parse.server.tests', {
directAccess: true
});

var anObject = {
aFile: fullFile
}
filesController.expandFilesInObject(config, anObject);
expect(anObject.aFile.url).toEqual("http://an.url");
FCTestFactory.testAdapter("S3AdapterDirect", s3DirectAccessAdapter);

done();
})
})
} else if (!process.env.TRAVIS) {
console.log("set S3_ACCESS_KEY and S3_SECRET_KEY to test S3Adapter")
}
});
73 changes: 73 additions & 0 deletions spec/FilesControllerTestFactory.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@

var FilesController = require('../src/Controllers/FilesController').FilesController;
var Config = require("../src/Config");

var testAdapter = function(name, adapter) {
// Small additional tests to improve overall coverage

var config = new Config(Parse.applicationId);
var filesController = new FilesController(adapter);

describe("FilesController with "+name,()=>{

it("should properly expand objects", (done) => {

var result = filesController.expandFilesInObject(config, function(){});

expect(result).toBeUndefined();

var fullFile = {
type: '__type',
url: "http://an.url"
}

var anObject = {
aFile: fullFile
}
filesController.expandFilesInObject(config, anObject);
expect(anObject.aFile.url).toEqual("http://an.url");

done();
})

it("should properly create, read, delete files", (done) => {
var filename;
filesController.createFile(config, "file.txt", "hello world").then( (result) => {
ok(result.url);
ok(result.name);
filename = result.name;
expect(result.name.match(/file.txt/)).not.toBe(null);
return filesController.getFileData(config, filename);
}, (err) => {
fail("The adapter should create the file");
console.error(err);
done();
}).then((result) => {
expect(result instanceof Buffer).toBe(true);
expect(result.toString('utf-8')).toEqual("hello world");
return filesController.deleteFile(config, filename);
}, (err) => {
fail("The adapter should get the file");
console.error(err);
done();
}).then((result) => {

filesController.getFileData(config, filename).then((res) => {
fail("the file should be deleted");
done();
}, (err) => {
done();
});

}, (err) => {
fail("The adapter should delete the file");
console.error(err);
done();
});
}, 5000); // longer tests
});
}

module.exports = {
testAdapter: testAdapter
}
2 changes: 1 addition & 1 deletion src/Adapters/Files/FilesAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// database adapter.

export class FilesAdapter {
createFile(config, filename, data) { }
createFile(config, filename: string, data, contentType: string) { }

deleteFile(config, filename) { }

Expand Down
2 changes: 1 addition & 1 deletion src/Adapters/Files/GridStoreAdapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ export class GridStoreAdapter extends FilesAdapter {

// For a given config object, filename, and data, store a file
// Returns a promise
createFile(config, filename: string, data) {
createFile(config, filename: string, data, contentType) {
return this._connect().then(database => {
let gridStore = new GridStore(database, filename, 'w');
return gridStore.open();
Expand Down
73 changes: 51 additions & 22 deletions src/Adapters/Files/S3Adapter.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,38 +48,61 @@ export class S3Adapter extends FilesAdapter {
};
AWS.config._region = this._region;
this._s3Client = new AWS.S3(s3Options);
this._hasBucket = false;
}

createBucket() {
var promise;
if (this._hasBucket) {
promise = Promise.resolve();
} else {
promise = new Promise((resolve, reject) => {
this._s3Client.createBucket(() => {
this._hasBucket = true;
resolve();
});
});
}
return promise;
}

// For a given config object, filename, and data, store a file in S3
// Returns a promise containing the S3 object creation response
createFile(config, filename, data) {
createFile(config, filename, data, contentType) {
let params = {
Key: this._bucketPrefix + filename,
Body: data
};
if (this._directAccess) {
params.ACL = "public-read"
}
return new Promise((resolve, reject) => {
this._s3Client.upload(params, (err, data) => {
if (err !== null) {
return reject(err);
}
resolve(data);
if (contentType) {
params.ContentType = contentType;
}
return this.createBucket().then(() => {
return new Promise((resolve, reject) => {
this._s3Client.upload(params, (err, data) => {
if (err !== null) {
return reject(err);
}
resolve(data);
});
});
});
}

deleteFile(config, filename) {
return new Promise((resolve, reject) => {
let params = {
Key: this._bucketPrefix + filename
};
this._s3Client.deleteObject(params, (err, data) =>{
if(err !== null) {
return reject(err);
}
resolve(data);
return this.createBucket().then(() => {
return new Promise((resolve, reject) => {
let params = {
Key: this._bucketPrefix + filename
};
this._s3Client.deleteObject(params, (err, data) =>{
if(err !== null) {
return reject(err);
}
resolve(data);
});
});
});
}
Expand All @@ -88,12 +111,18 @@ export class S3Adapter extends FilesAdapter {
// Returns a promise that succeeds with the buffer result from S3
getFileData(config, filename) {
let params = {Key: this._bucketPrefix + filename};
return new Promise((resolve, reject) => {
this._s3Client.getObject(params, (err, data) => {
if (err !== null) {
return reject(err);
}
resolve(data.Body);
return this.createBucket().then(() => {
return new Promise((resolve, reject) => {
this._s3Client.getObject(params, (err, data) => {
if (err !== null) {
return reject(err);
}
// Something happend here...
if (data && !data.Body) {
return reject(data);
}
resolve(data.Body);
});
});
});
}
Expand Down
18 changes: 16 additions & 2 deletions src/Controllers/FilesController.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,31 @@ import { Parse } from 'parse/node';
import { randomHexString } from '../cryptoUtils';
import AdaptableController from './AdaptableController';
import { FilesAdapter } from '../Adapters/Files/FilesAdapter';
import path from 'path';
import mime from 'mime';

export class FilesController extends AdaptableController {

getFileData(config, filename) {
return this.adapter.getFileData(config, filename);
}

createFile(config, filename, data) {
createFile(config, filename, data, contentType) {

let extname = path.extname(filename);

const hasExtension = extname.length > 0;

if (!hasExtension && contentType && mime.extension(contentType)) {
filename = filename + '.' + mime.extension(contentType);
} else if (hasExtension && !contentType) {
contentType = mime.lookup(filename);
}

filename = randomHexString(32) + '_' + filename;

var location = this.adapter.getFileLocation(config, filename);
return this.adapter.createFile(config, filename, data).then(() => {
return this.adapter.createFile(config, filename, data, contentType).then(() => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is sort of breaking - can we add this to the docs on FilesAdapter?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeppa

return Promise.resolve({
url: location,
name: filename
Expand Down
15 changes: 4 additions & 11 deletions src/Routers/FilesRouter.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import express from 'express';
import BodyParser from 'body-parser';
import * as Middlewares from '../middlewares';
import { randomHexString } from '../cryptoUtils';
import mime from 'mime';
import Config from '../Config';
import mime from 'mime';

export class FilesRouter {

Expand Down Expand Up @@ -41,7 +41,7 @@ export class FilesRouter {
var contentType = mime.lookup(filename);
res.set('Content-Type', contentType);
res.end(data);
}).catch(() => {
}).catch((err) => {
res.status(404);
res.set('Content-Type', 'text/plain');
res.end('File not found.');
Expand All @@ -66,20 +66,13 @@ export class FilesRouter {
'Filename contains invalid characters.'));
return;
}
let extension = '';

// Not very safe there.
const hasExtension = req.params.filename.indexOf('.') > 0;
const filename = req.params.filename;
const contentType = req.get('Content-type');
if (!hasExtension && contentType && mime.extension(contentType)) {
extension = '.' + mime.extension(contentType);
}

const filename = req.params.filename + extension;
const config = req.config;
const filesController = config.filesController;

filesController.createFile(config, filename, req.body).then((result) => {
filesController.createFile(config, filename, req.body, contentType).then((result) => {
res.status(201);
res.set('Location', result.url);
res.json(result);
Expand Down