feat: image processing (#744)

close #676

Author: weiyie

README.md

@@ -2673,6 +2673,33 @@ object:
 - status {Number} response status
 - res {Object} response info
 
+### .processObjectSave(sourceObject, targetObject, process[, targetBucket])
+
+Persistency indicates that images are asynchronously stored in the specified Bucket
+
+parameters:
+
+- sourceObject {String} source object name
+- targetObject {String} target object name
+- process {String} process string
+- [targetBucket] {String} target bucket
+
+Success will return the channel information.
+
+object:
+
+- status {Number} response status
+- res {Object} response info
+
+
+```js
+const sourceObject = 'a.png'
+const targetObject = 'b.png'
+const process = 'image/watermark,text_aGVsbG8g5Zu+54mH5pyN5Yqh77yB,color_ff6a00'
+
+await this.store.processObjectSave(sourceObject, targetObject, process);
+```
+
 ## RTMP Operations
 
 All operations function is [async], except `getRtmpUrl`.

lib/browser/object.js

@@ -278,6 +278,7 @@ merge(proto, require('../common/object/copyObject'));
 merge(proto, require('../common/object/getObjectTagging'));
 merge(proto, require('../common/object/putObjectTagging'));
 merge(proto, require('../common/object/deleteObjectTagging'));
+merge(proto, require('../common/image'));
 
 proto.putMeta = async function putMeta(name, meta, options) {
   const copyResult = await this.copy(name, name, {

lib/client.js

@@ -73,6 +73,7 @@ const proto = Client.prototype;
  */
 merge(proto, require('./common/object'));
 merge(proto, require('./object'));
+merge(proto, require('./common/image'));
 /**
  * Bucket operations
  */

lib/common/image/index.js

@@ -0,0 +1,5 @@
+const merge = require('merge-descriptors');
+
+const proto = exports;
+
+merge(proto, require('./processObjectSave'));

lib/common/image/processObjectSave.js

@@ -0,0 +1,42 @@
+/* eslint-disable no-use-before-define */
+const querystring = require('querystring');
+const { Base64: { encode: str2Base64 } } = require('js-base64');
+
+const proto = exports;
+
+proto.processObjectSave = async function processObjectSave(sourceObject, targetObject, process, targetBucket) {
+  checkArgs(sourceObject, 'sourceObject');
+  checkArgs(targetObject, 'targetObject');
+  checkArgs(process, 'process');
+  targetObject = this._objectName(targetObject);
+  if (targetBucket) {
+    this._checkBucketName(targetBucket);
+  }
+
+  const params = this._objectRequestParams('POST', sourceObject, {
+    subres: 'x-oss-process'
+  });
+
+  const bucketParam = targetBucket ? `,b_${str2Base64(targetBucket)}` : '';
+  targetObject = str2Base64(targetObject);
+
+  const content = {
+    'x-oss-process': `${process}|sys/saveas,o_${targetObject}${bucketParam}`
+  };
+  params.content = querystring.stringify(content);
+
+  const result = await this.request(params);
+  return {
+    res: result.res,
+    status: result.res.status
+  };
+};
+
+function checkArgs(name, key) {
+  if (!name) {
+    throw new Error(`${key} is required`);
+  }
+  if (typeof name !== 'string') {
+    throw new Error(`${key} must be String`);
+  }
+}

package.json

@@ -120,6 +120,7 @@
     "get-ready": "^1.0.0",
     "humanize-ms": "^1.2.0",
     "is-type-of": "^1.0.0",
+    "js-base64": "^2.5.2",
     "jstoxml": "^0.2.3",
     "merge-descriptors": "^1.0.1",
     "mime": "^1.3.4",

test/node/object.test.js

@@ -161,6 +161,75 @@ describe('test/object.test.js', () => {
     });
   });
 
+  describe('processObjectSave()', () => {
+    const name = 'sourceObject.png';
+    before(async () => {
+      const imagepath = path.join(__dirname, 'nodejs-1024x768.png');
+      await store.putStream(name, fs.createReadStream(imagepath), {
+        mime: 'image/png'
+      });
+    });
+    const target = `processObject_target${Date.now()}.jpg`;
+    it('should process image', async () => {
+      try {
+        const result = await store.processObjectSave(name, target, 'image/watermark,text_aGVsbG8g5Zu+54mH5pyN5Yqh77yB,color_ff6a00,');
+        assert.strictEqual(result.res.status, 200);
+      } catch (error) {
+        assert(false, error);
+      }
+    });
+    it('should process image with targetBucket', async () => {
+      try {
+        const result = await store.processObjectSave(name, target, 'image/watermark,text_aGVsbG8g5Zu+54mH5pyN5Yqh77yB,color_ff6a00,', archvieBucket);
+        assert.strictEqual(result.res.status, 200);
+      } catch (error) {
+        assert(false, error);
+      }
+    });
+    it('should throw error when sourceObjectName is invalid', async () => {
+      try {
+        await store.processObjectSave('', target, 'image/watermark,text_aGVsbG8g5Zu+54mH5pyN5Yqh77yB,color_ff6a00,');
+        assert(false);
+      } catch (error) {
+        assert(error.message.includes('required'));
+      }
+      try {
+        await store.processObjectSave({}, target, 'image/watermark,text_aGVsbG8g5Zu+54mH5pyN5Yqh77yB,color_ff6a00,');
+        assert(false);
+      } catch (error) {
+        assert(error.message.includes('must be String'));
+      }
+    });
+    it('should throw error when targetObjectName is invalid', async () => {
+      try {
+        await store.processObjectSave(name, '', 'image/watermark,text_aGVsbG8g5Zu+54mH5pyN5Yqh77yB,color_ff6a00,');
+        assert(false);
+      } catch (error) {
+        assert(error.message.includes('required'));
+      }
+      try {
+        await store.processObjectSave(name, {}, 'image/watermark,text_aGVsbG8g5Zu+54mH5pyN5Yqh77yB,color_ff6a00,');
+        assert(false);
+      } catch (error) {
+        assert(error.message.includes('must be String'));
+      }
+    });
+    it('should throw error when process is invalid', async () => {
+      try {
+        await store.processObjectSave(name, target, '');
+        assert(false);
+      } catch (error) {
+        assert(error.message.includes('required'));
+      }
+      try {
+        await store.processObjectSave(name, target, {});
+        assert(false);
+      } catch (error) {
+        assert(error.message.includes('must be String'));
+      }
+    });
+  });
+
   describe('getObjectUrl()', () => {
     it('should return object url', () => {
       let name = 'test.js';