Merge pull request #164 from wchaws/dev

feat: add threshold

Author: wchaws

source/new-image-handler/src/processor/image/index.ts

@@ -20,6 +20,7 @@ import { RotateAction } from './rotate';
 import { RoundedCornersAction } from './rounded-corners';
 import { SharpenAction } from './sharpen';
 import { StripMetadataAction } from './strip-metadata';
+import { ThresholdAction } from './threshold';
 import { WatermarkAction } from './watermark';
 
 export interface IImageInfo {
@@ -226,6 +227,7 @@ ImageProcessor.getInstance().register(
   new InfoAction(),
   new CgifAction(),
   new StripMetadataAction(),
+  new ThresholdAction(),
 );
 
 

source/new-image-handler/src/processor/image/threshold.ts

@@ -0,0 +1,38 @@
+import { IImageContext } from '.';
+import { IActionOpts, ReadOnly, InvalidArgument } from '..';
+import { BaseImageAction } from './_base';
+
+
+export interface ThresholdOpts extends IActionOpts {
+  threshold: number;
+}
+
+
+export class ThresholdAction extends BaseImageAction {
+  public readonly name: string = 'threshold';
+
+  public beforeProcess(ctx: IImageContext, params: string[], _: number): void {
+    const opts = this.validate(params);
+
+    if (ctx.metadata.size && (ctx.metadata.size < opts.threshold)) {
+      ctx.mask.disableAll();
+    }
+  }
+
+  public validate(params: string[]): ReadOnly<ThresholdOpts> {
+    if (params.length !== 2) {
+      throw new InvalidArgument(`Invalid ${this.name} params, incomplete param`);
+    }
+    const t = Number.parseInt(params[1], 10);
+    if (t <= 0) {
+      throw new InvalidArgument(`Invalid ${this.name} params, threshold must be greater than zero`);
+    }
+    return {
+      threshold: t,
+    };
+  }
+
+  public async process(_1: IImageContext, _2: string[]): Promise<void> {
+    return Promise.resolve();
+  }
+}

source/new-image-handler/test/fixtures/.gitignore

@@ -0,0 +1,5 @@
+*.gif
+*.png
+*.PNG
+*.jpeg
+*.jpg

source/new-image-handler/test/processor/image/threshold.test.ts

@@ -0,0 +1,36 @@
+// import * as sharp from 'sharp';
+import { ThresholdAction } from '../../../src/processor/image/threshold';
+import { mkctx } from './utils';
+
+test(`${ThresholdAction.name} action validate`, () => {
+  const action = new ThresholdAction();
+  const param = action.validate('threshold,100'.split(','));
+  expect(param.threshold).toBe(100);
+
+  expect(() => {
+    action.validate('threshold'.split(','));
+  }).toThrow(/Invalid/);
+
+  expect(() => {
+    action.validate('threshold,-1'.split(','));
+  }).toThrow(/Invalid.*greater than zero/);
+
+});
+
+
+test(`${ThresholdAction.name} beforeProcess mask disabled`, async () => {
+  const ctx = await mkctx('example.jpg', ['threshold,23000']);
+  const action = new ThresholdAction();
+
+  await action.beforeProcess(ctx, 'threshold,23000'.split(','), 0);
+  expect(ctx.mask.isDisabled(0)).toBeTruthy();
+});
+
+
+test(`${ThresholdAction.name} beforeProcess mask enabled`, async () => {
+  const ctx = await mkctx('example.jpg', ['threshold,100']);
+  const action = new ThresholdAction();
+
+  await action.beforeProcess(ctx, 'threshold,100'.split(','), 0);
+  expect(ctx.mask.isEnabled(0)).toBeTruthy();
+});

source/new-image-handler/test/processor/index.test.ts

@@ -74,6 +74,26 @@ test('image/resize,w_50/crop,w_100,h_100/rounded-corners,r_100/format,png', asyn
   expect(info.channels).toBe(4);
 });
 
+test('example.jpg?x-oss-process=image/resize,w_50/threshold,10', async () => {
+  const ctx = await ImageProcessor.getInstance().newContext('example.jpg', 'image/resize,w_50/threshold,10'.split('/'), fixtureStore);
+  await ImageProcessor.getInstance().process(ctx);
+  const { info } = await ctx.image.toBuffer({ resolveWithObject: true });
+
+  expect(info.width).toBe(50);
+  expect(info.height).toBe(33);
+  expect(info.channels).toBe(3);
+});
+
+test('example.jpg?x-oss-process=image/resize,w_50/threshold,23000', async () => {
+  const ctx = await ImageProcessor.getInstance().newContext('example.jpg', 'image/resize,w_50/threshold,23000'.split('/'), fixtureStore);
+  await ImageProcessor.getInstance().process(ctx);
+  const { info } = await ctx.image.toBuffer({ resolveWithObject: true });
+
+  expect(info.width).toBe(400);
+  expect(info.height).toBe(267);
+  expect(info.channels).toBe(3);
+});
+
 test('image/resize,w_20/indexcrop,x_50,i_0/', async () => {
   const ctx = await ImageProcessor.getInstance().newContext('example.jpg', 'image/resize,w_20/indexcrop,x_50,i_0/'.split('/'), fixtureStore);
   await ImageProcessor.getInstance().process(ctx);