Skip to content

GCF ImageMagick: Make sample version-agnostic + add infinite loop protection #763

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.

Sign up for GitHub

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
ace-n merged 2 commits into from
Oct 16, 2018
Merged

GCF ImageMagick: Make sample version-agnostic + add infinite loop protection #763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53e3cc4
Make sample version-agnostic + add infinite loop protection
Oct 11, 2018
95be586
Merge branch 'master' into imagick-node-versions
crwilcox Oct 15, 2018
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
13 changes: 11 additions & 2 deletions functions/imagemagick/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const client = new vision.ImageAnnotatorClient();
// [START functions_imagemagick_analyze]
// Blurs uploaded images that are flagged as Adult or Violence.
exports.blurOffensiveImages = (event) => {
const object = event.data;
const object = event.data || event;

// Exit if this is a deletion or a deploy event.
if (object.resourceState === 'not_exists') {
Expand All @@ -42,6 +42,12 @@ exports.blurOffensiveImages = (event) => {
const file = storage.bucket(object.bucket).file(object.name);
const filePath = `gs://${object.bucket}/${object.name}`;

// Ignore already-blurred files (to prevent re-invoking this function)
if (file.name.startsWith('blurred-')) {
console.log(`The image ${file.name} is already blurred.`);
return;
}

console.log(`Analyzing ${file.name}.`);

return client.safeSearchDetection(filePath)
Expand Down Expand Up @@ -92,8 +98,11 @@ function blurImage (file) {
.then(() => {
console.log(`Image ${file.name} has been blurred.`);

// Mark result as blurred, to avoid re-triggering this function.
const newName = `blurred-${file.name}`;

// Upload the Blurred image back into the bucket.
return file.bucket.upload(tempLocalPath, { destination: file.name })
return file.bucket.upload(tempLocalPath, { destination: newName })
.catch((err) => {
console.error('Failed to upload blurred image.', err);
return Promise.reject(err);
Expand Down
36 changes: 27 additions & 9 deletions functions/imagemagick/test/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const tools = require(`@google-cloud/nodejs-repo-tools`);
const vision = require('@google-cloud/vision').v1p1beta1;

const bucketName = `my-bucket`;
const filename = `image.jpg`;
const defaultFileName = `image.jpg`;

var VisionStub = sinon.stub(vision, 'ImageAnnotatorClient');
VisionStub.returns({
Expand All @@ -34,7 +34,7 @@ VisionStub.returns({
}]))
});

function getSample () {
function getSample (filename) {
const file = {
getMetadata: sinon.stub().returns(Promise.resolve([{}])),
setMetadata: sinon.stub().returns(Promise.resolve()),
Expand Down Expand Up @@ -82,20 +82,20 @@ test.beforeEach(tools.stubConsole);
test.afterEach.always(tools.restoreConsole);

test.serial(`blurOffensiveImages does nothing on delete`, async (t) => {
await getSample().program.blurOffensiveImages({ data: { resourceState: `not_exists` } });
await getSample(defaultFileName).program.blurOffensiveImages({ data: { resourceState: `not_exists` } });
t.is(console.log.callCount, 1);
t.deepEqual(console.log.getCall(0).args, ['This is a deletion event.']);
});

test.serial(`blurOffensiveImages does nothing on deploy`, async (t) => {
await getSample().program.blurOffensiveImages({ data: {} });
await getSample(defaultFileName).program.blurOffensiveImages({ data: {} });
t.is(console.log.callCount, 1);
t.deepEqual(console.log.getCall(0).args, ['This is a deploy event.']);
});

test.serial(`blurOffensiveImages blurs images`, async (t) => {
const sample = getSample();
await sample.program.blurOffensiveImages({ data: { bucket: bucketName, name: filename } });
test.serial(`blurOffensiveImages blurs unblurred images (Node 6 syntax)`, async (t) => {
const sample = getSample(defaultFileName);
await sample.program.blurOffensiveImages({ data: { bucket: bucketName, name: defaultFileName } });
t.is(console.log.callCount, 5);
t.deepEqual(console.log.getCall(0).args, [`Analyzing ${sample.mocks.file.name}.`]);
t.deepEqual(console.log.getCall(1).args, [`The image ${sample.mocks.file.name} has been detected as inappropriate.`]);
Expand All @@ -104,6 +104,24 @@ test.serial(`blurOffensiveImages blurs images`, async (t) => {
t.deepEqual(console.log.getCall(4).args, [`Blurred image has been uploaded to ${sample.mocks.file.name}.`]);
});

test.serial(`blurOffensiveImages blurs unblurred images (Node 8 syntax)`, async (t) => {
const sample = getSample(defaultFileName);
await sample.program.blurOffensiveImages({ bucket: bucketName, name: defaultFileName });
t.is(console.log.callCount, 5);
t.deepEqual(console.log.getCall(0).args, [`Analyzing ${sample.mocks.file.name}.`]);
t.deepEqual(console.log.getCall(1).args, [`The image ${sample.mocks.file.name} has been detected as inappropriate.`]);
t.deepEqual(console.log.getCall(2).args, [`Image ${sample.mocks.file.name} has been downloaded to /tmp/${sample.mocks.file.name}.`]);
t.deepEqual(console.log.getCall(3).args, [`Image ${sample.mocks.file.name} has been blurred.`]);
t.deepEqual(console.log.getCall(4).args, [`Blurred image has been uploaded to ${sample.mocks.file.name}.`]);
});

test.serial(`blurOffensiveImages ignores already-blurred images`, async (t) => {
const sample = getSample(`blurred-${defaultFileName}`);
await sample.program.blurOffensiveImages({ data: { bucket: bucketName, name: `blurred-${defaultFileName}` } });
t.is(console.log.callCount, 1);
t.deepEqual(console.log.getCall(0).args, [`The image ${sample.mocks.file.name} is already blurred.`]);
});

test.serial(`blurOffensiveImages ignores safe images`, async (t) => {
VisionStub.restore();
VisionStub = sinon.stub(vision, 'ImageAnnotatorClient');
Expand All @@ -115,8 +133,8 @@ test.serial(`blurOffensiveImages ignores safe images`, async (t) => {
}
}]))
});
const sample = getSample();
await sample.program.blurOffensiveImages({ data: { bucket: bucketName, name: filename } });
const sample = getSample(defaultFileName);
await sample.program.blurOffensiveImages({ data: { bucket: bucketName, name: defaultFileName } });
t.is(console.log.callCount, 2);
t.deepEqual(console.log.getCall(0).args, [`Analyzing ${sample.mocks.file.name}.`]);
t.deepEqual(console.log.getCall(1).args, [`The image ${sample.mocks.file.name} has been detected as OK.`]);
Expand Down