feat: add cls module

yugasun · yugasun · commit 127ff5cc1eef · 2020-12-01T10:20:45.000+08:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -41,16 +41,16 @@ jobs:
       - name: Running integration tests
         run: npm run test
         env:
-          TENCENT_SECRET_ID: ${{ secrets.TENCENT_SECRET_ID}}
-          TENCENT_SECRET_KEY: ${{ secrets.TENCENT_SECRET_KEY}}
-          TENCENT_UIN: ${{ secrets.TENCENT_UIN}}
-          TENCENT_APP_ID: ${{ secrets.TENCENT_APP_ID}}
-          BUCKET: ${{ secrets.BUCKET}}
-          DOMAIN: ${{ secrets.DOMAIN}}
-          SUB_DOMAIN: ${{ secrets.SUB_DOMAIN}}
-          REGION: ${{ secrets.REGION}}
-          ZONE: ${{ secrets.ZONE}}
-          VPC_ID: ${{ secrets.VPC_ID}}
-          SUBNET_ID: ${{ secrets.SUBNET_ID}}
-          CFS_VPC_ID: ${{ secrets.CFS_VPC_ID}}
-          CFS_SUBNET_ID: ${{ secrets.CFS_SUBNET_ID}}
+          TENCENT_SECRET_ID: ${{ secrets.TENCENT_SECRET_ID }}
+          TENCENT_SECRET_KEY: ${{ secrets.TENCENT_SECRET_KEY }}
+          TENCENT_UIN: ${{ secrets.TENCENT_UIN }}
+          TENCENT_APP_ID: ${{ secrets.TENCENT_APP_ID }}
+          BUCKET: ${{ secrets.BUCKET }}
+          DOMAIN: ${{ secrets.DOMAIN }}
+          SUB_DOMAIN: ${{ secrets.SUB_DOMAIN }}
+          REGION: ${{ secrets.REGION }}
+          ZONE: ${{ secrets.ZONE }}
+          VPC_ID: ${{ secrets.VPC_ID }}
+          SUBNET_ID: ${{ secrets.SUBNET_ID }}
+          CFS_VPC_ID: ${{ secrets.CFS_VPC_ID }}
+          CFS_SUBNET_ID: ${{ secrets.CFS_SUBNET_ID }}
diff --git a/__tests__/apigw.test.js b/__tests__/apigw.test.js
@@ -120,7 +120,7 @@ describe('apigw', () => {
       apiList: [
         {
           path: '/',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           method: 'GET',
           apiName: 'index',
           apiId: expect.stringContaining('api-'),
@@ -130,23 +130,23 @@ describe('apigw', () => {
           path: '/mo',
           method: 'GET',
           apiName: 'mo',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           apiId: expect.stringContaining('api-'),
           created: true,
         },
         {
           path: '/auto',
           method: 'GET',
           apiName: 'auto-http',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           apiId: expect.stringContaining('api-'),
           created: true,
         },
         {
           path: '/ws',
           method: 'GET',
           apiName: 'ws-test',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           apiId: expect.stringContaining('api-'),
           created: true,
         },
@@ -192,7 +192,7 @@ describe('apigw', () => {
       apiList: [
         {
           path: '/',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           method: 'GET',
           apiName: 'index',
           apiId: expect.stringContaining('api-'),
@@ -210,23 +210,23 @@ describe('apigw', () => {
           path: '/mo',
           method: 'GET',
           apiName: 'mo',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           apiId: expect.stringContaining('api-'),
           created: true,
         },
         {
           path: '/auto',
           method: 'GET',
           apiName: 'auto-http',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           apiId: expect.stringContaining('api-'),
           created: true,
         },
         {
           path: '/ws',
           method: 'GET',
           apiName: 'ws-test',
-          internalDomain: null,
+          internalDomain: expect.any(String),
           apiId: expect.stringContaining('api-'),
           created: true,
         },
diff --git a/__tests__/cls.test.js b/__tests__/cls.test.js
@@ -0,0 +1,55 @@
+const { Cls } = require('../src');
+
+describe('Cls', () => {
+  const credentials = {
+    SecretId: process.env.TENCENT_SECRET_ID,
+    SecretKey: process.env.TENCENT_SECRET_KEY,
+  };
+  const client = new Cls(credentials, process.env.REGION, 600000);
+
+  let outputs = {};
+
+  const inputs = {
+    region: 'ap-guangzhou',
+    name: 'cls-test',
+    topic: 'cls-topic-test',
+    period: 7,
+    rule: {
+      full_text: {
+        case_sensitive: true,
+        tokenizer: '!@#%^&*()_="\', <>/?|\\;:\n\t\r[]{}',
+      },
+      key_value: {
+        case_sensitive: true,
+        keys: ['SCF_RetMsg'],
+        types: ['text'],
+        tokenizers: [' '],
+      },
+    },
+  };
+
+  test('should deploy cls success', async () => {
+    const res = await client.deploy(inputs);
+    expect(res).toEqual({
+      region: process.env.REGION,
+      name: inputs.name,
+      topic: inputs.topic,
+      logsetId: expect.any(String),
+      topicId: expect.any(String),
+    });
+
+    outputs = res;
+  });
+
+  test('should remove cls success', async () => {
+    await client.remove(outputs);
+
+    const detail = await client.cls.getLogset({
+      logset_id: outputs.logsetId,
+    });
+    expect(detail.logset_id).toBeUndefined();
+    expect(detail.error).toEqual({
+      message: expect.any(String),
+    });
+  });
+});
diff --git a/__tests__/scf.test.js b/__tests__/scf.test.js
@@ -217,7 +217,7 @@ describe('Scf', () => {
           apiList: [
             {
               path: '/',
-              internalDomain: null,
+              internalDomain: expect.any(String),
               method: 'GET',
               apiName: 'index',
               apiId: expect.stringContaining('api-'),
diff --git a/package.json b/package.json
@@ -75,6 +75,7 @@
   },
   "dependencies": {
     "@tencent-sdk/capi": "^1.1.5",
+    "@tencent-sdk/cls": "^0.1.6",
     "@ygkit/request": "^0.1.1",
     "cos-nodejs-sdk-v5": "^2.6.2",
     "moment": "^2.25.3",
diff --git a/src/index.js b/src/index.js
@@ -15,4 +15,5 @@ module.exports = {
   Layer: require('./modules/layer'),
   Cfs: require('./modules/cfs'),
   Cynosdb: require('./modules/cynosdb'),
+  Cls: require('./modules/cls'),
 };
diff --git a/src/modules/apigw/index.js b/src/modules/apigw/index.js
@@ -625,7 +625,7 @@ class Apigw {
         serviceId: serviceId,
         apiId: output.apiId,
       });
-      output.internalDomain = apiDetail.InternalDomain;
+      output.internalDomain = apiDetail.InternalDomain || '';
     } else {
       console.log(`Updating api ${endpoint.apiId}.`);
       this.marshalApiInput(endpoint, apiInputs);
@@ -636,7 +636,7 @@ class Apigw {
       });
       output.apiId = endpoint.apiId;
       output.created = !!created;
-      output.internalDomain = apiDetail.InternalDomain;
+      output.internalDomain = apiDetail.InternalDomain || '';
       console.log(`Api ${output.apiId} updated`);
     }
 
diff --git a/src/modules/cls/index.js b/src/modules/cls/index.js
@@ -0,0 +1,180 @@
+const ClsClient = require('@tencent-sdk/cls').Cls;
+const { ApiError } = require('../../utils/error');
+const { createLogset, createTopic, updateIndex } = require('./utils');
+
+class Cls {
+  constructor(credentials = {}, region, expire) {
+    this.region = region || 'ap-guangzhou';
+    this.credentials = credentials;
+    this.cls = new ClsClient({
+      region: this.region,
+      secretId: credentials.SecretId,
+      secretKey: credentials.SecretKey,
+      token: credentials.Token,
+      debug: false,
+      expire: expire || 300000,
+    });
+  }
+
+  async deployLogset(inputs) {
+    const outputs = {
+      region: this.region,
+      name: inputs.name,
+      logsetId: '',
+    };
+    let exist = false;
+    const { logsetId } = inputs;
+    if (logsetId) {
+      const detail = await this.cls.getLogset({
+        logset_id: logsetId,
+      });
+      if (detail.error) {
+        throw new ApiError({
+          type: 'API_getLogset',
+          message: detail.error.message,
+        });
+      }
+
+      // update it
+      if (detail.logset_id) {
+        exist = true;
+        console.log(`Updating cls ${logsetId}`);
+        const res = await this.cls.updateLogset({
+          logset_id: logsetId,
+          logset_name: inputs.name,
+        });
+        if (res.error) {
+          throw new ApiError({
+            type: 'API_updateLogset',
+            message: detail.error.message,
+          });
+        }
+
+        console.log(`Update cls ${logsetId} success`);
+
+        outputs.logsetId = logsetId;
+      }
+    }
+
+    // if not exist, create cls
+    if (!exist) {
+      const res = await createLogset(this.cls, {
+        name: inputs.name,
+        period: inputs.period,
+      });
+      outputs.logsetId = res.logset_id;
+    }
+
+    return outputs;
+  }
+
+  async deployTopic(inputs) {
+    const outputs = {
+      region: this.region,
+      name: inputs.topic,
+      topicId: '',
+    };
+    let exist = false;
+    const { topicId } = inputs;
+    if (topicId) {
+      const detail = await this.cls.getTopic({
+        topic_id: topicId,
+      });
+      if (detail.error) {
+        throw new ApiError({
+          type: 'API_getTopic',
+          message: detail.error.message,
+        });
+      }
+
+      // update it
+      if (detail.topic_id) {
+        exist = true;
+        console.log(`Updating cls topic ${topicId}`);
+        const res = await this.cls.updateTopic({
+          topic_id: topicId,
+          topic_name: inputs.topic,
+        });
+        if (res.error) {
+          throw new ApiError({
+            type: 'API_updateTopic',
+            message: detail.error.message,
+          });
+        }
+
+        console.log(`Update cls topic ${topicId} success`);
+
+        outputs.topicId = topicId;
+      }
+    }
+
+    // if not exist, create cls
+    if (!exist) {
+      const res = await createTopic(this.cls, {
+        logsetId: inputs.logsetId,
+        name: inputs.topic,
+      });
+      outputs.topicId = res.topic_id;
+    }
+
+    return outputs;
+  }
+
+  async deployIndex(inputs) {
+    await updateIndex(this.cls, {
+      topicId: inputs.topicId,
+      effective: inputs.effective !== false ? true : false,
+      rule: inputs.rule,
+    });
+  }
+
+  async deploy(inputs = {}) {
+    const outputs = {
+      region: this.region,
+      name: inputs.name,
+      topic: inputs.topic,
+    };
+
+    const logsetOutput = await this.deployLogset(inputs);
+    outputs.logsetId = inputs.logsetId = logsetOutput.logsetId;
+    const topicOutput = await this.deployTopic(inputs);
+    outputs.topicId = inputs.topicId = topicOutput.topicId;
+    await this.deployIndex(inputs);
+
+    return outputs;
+  }
+
+  async remove(inputs = {}) {
+    try {
+      console.log(`Start removing cls`);
+      console.log(`Removing cls topic id ${inputs.topicId}`);
+      const res1 = await this.cls.deleteTopic({
+        topic_id: inputs.topicId,
+      });
+      if (res1.error) {
+        throw new ApiError({
+          type: 'API_deleteTopic',
+          message: res1.error.message,
+        });
+      }
+      console.log(`Removed cls topic id ${inputs.logsetId} success`);
+      console.log(`Removing cls id ${inputs.logsetId}`);
+      const res2 = await this.cls.deleteLogset({
+        logset_id: inputs.logsetId,
+      });
+      if (res2.error) {
+        throw new ApiError({
+          type: 'API_deleteLogset',
+          message: res2.error.message,
+        });
+      }
+      console.log(`Removed cls id ${inputs.logsetId} success`);
+    } catch (e) {
+      console.log(e);
+    }
+
+    return {};
+  }
+}
+
+module.exports = Cls;
diff --git a/src/modules/cls/utils.js b/src/modules/cls/utils.js

Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ describe('Scf', () => {`
`217`	`217`	`apiList: [`
`218`	`218`	`{`
`219`	`219`	`path: '/',`
`220`		`- internalDomain: null,`
	`220`	`+ internalDomain: expect.any(String),`
`221`	`221`	`method: 'GET',`
`222`	`222`	`apiName: 'index',`
`223`	`223`	`apiId: expect.stringContaining('api-'),`