breaking: refactor with typescript 🚀 (#177)

* refactory(ts): almost all files are typescript now 🚀

* chore: move files from build to lib for better import, fix error in cdn

* test: sleep longer to ensure layer deploy success

* fix: update the workflow build scripts

* fix: remove dummy file .json

* refactory(ts): refactory apigw, ensure type clearer

* fix: region type from enum to string

* refactor(ts): update cam

* refactor(ts): rename camelCase to pascalCase, make more accurate

* refactor(ts): update cos to the latest sdk

* refactor(ts): add comment and remove any in cynosdb

* refactor(ts): check domain, layer, postgresql, remove uneccesary any

* refactor(ts): update tag, vpc and error

* refactor(ts): update apigw, scf, multi-apigw, multi-scf

* refactor(ts): update apigw, scf, multi-apigw, multi-scf

* fix: fix bugs after refactor

* fix: fix error after rebase

* fix(cynosdb): generate password

* test(cynosdb): fix

* fix(cynosdb): method isSupportZone

* fix: fix some logic, naming and apis

* chore: update eslint and prettier support

* chore: use prettier to format files

* chore: update eslint config, fix lint issues

* chore: add breaking commit type

Co-authored-by: yugasun <[email protected]>

Author: wwwzbwcom

.eslintignore

@@ -2,3 +2,6 @@ coverage
 dist
 node_modules
 example
+# ignore for dont check build result
+lib
+**/*.d.ts

.eslintrc.js

@@ -1,20 +1,25 @@
 module.exports = {
   root: true,
   extends: ['prettier'],
-  plugins: ['import', 'prettier'],
+  plugins: ['import', 'prettier', '@typescript-eslint'],
   env: {
     es6: true,
     jest: true,
     node: true,
   },
-  parser: 'babel-eslint',
+  parser: '@typescript-eslint/parser',
   parserOptions: {
     ecmaVersion: 2018,
     sourceType: 'module',
     ecmaFeatures: {
       jsx: true,
     },
   },
+  overrides: [
+    {
+      files: ['./src/**/*.ts', './__test__/**.*.js'],
+    },
+  ],
   globals: {
     on: true, // for the Socket file
   },
@@ -47,9 +52,9 @@ module.exports = {
     'no-const-assign': 'error',
     'no-else-return': 'error',
     'no-empty': 'off',
-    'no-shadow': 'error',
+    '@typescript-eslint/no-shadow': 'error',
     'no-undef': 'error',
-    'no-unused-vars': 'error',
+    '@typescript-eslint/no-unused-vars': 'error',
     'no-use-before-define': 'error',
     'no-useless-constructor': 'error',
     'object-curly-newline': 'off',

.github/workflows/release.yml

@@ -37,6 +37,10 @@ jobs:
         run: |
           npm update --no-save
           npm update --save-dev --no-save
+
+      - name: Build
+        run: npm run build
+
       - name: Releasing
         run: |
           npm run release

.github/workflows/test.yml

@@ -38,6 +38,10 @@ jobs:
         run: |
           npm update --no-save
           npm update --save-dev --no-save
+
+      - name: Build
+        run: npm run build
+
       - name: Running tests
         run: npm run test
         env:

.gitignore

@@ -16,6 +16,7 @@ node_modules
 dist
 .idea
 build
+lib
 .env*
 .env.test
 !.env.example

__tests__/apigw.test.js

@@ -1,4 +1,4 @@
-const { Apigw } = require('../src');
+const { Apigw } = require('../lib');
 
 const deepClone = (obj) => {
   return JSON.parse(JSON.stringify(obj));

__tests__/cam.test.js

@@ -1,4 +1,4 @@
-const { Cam } = require('../src');
+const { Cam } = require('../lib');
 
 describe('Cam', () => {
   const credentials = {

__tests__/cdn.test.js

@@ -1,5 +1,5 @@
-const { Cdn } = require('../src');
-const { getCdnByDomain } = require('../src/modules/cdn/utils');
+const { Cdn } = require('../lib');
+const { getCdnByDomain } = require('../lib/modules/cdn/utils');
 
 describe('Cdn', () => {
   jest.setTimeout(600000);

__tests__/cfs.test.js

@@ -1,6 +1,6 @@
 const { sleep } = require('@ygkit/request');
-const { Cfs } = require('../src');
-const apis = require('../src/modules/cfs/apis');
+const { Cfs } = require('../lib');
+const utils = require('../lib/modules/cfs/utils').default;
 
 describe('Cfs', () => {
   const credentials = {
@@ -44,7 +44,7 @@ describe('Cfs', () => {
   test('should remove CFS success', async () => {
     await sleep(1000);
     const res = await cfs.remove(inputs);
-    const detail = await apis.getCfs(cfs.capi, inputs.fileSystemId);
+    const detail = await utils.getCfs(cfs.capi, inputs.fileSystemId);
     expect(res).toEqual({});
     expect(detail).toBeUndefined();
   });

__tests__/cls.test.js

@@ -1,4 +1,5 @@
-const { Cls } = require('../src');
+const { Cls } = require('../lib');
+const { sleep } = require('@ygkit/request');
 
 describe('Cls', () => {
   const credentials = {
@@ -42,6 +43,7 @@ describe('Cls', () => {
   });
 
   test('should remove cls success', async () => {
+    await sleep(2000);
     await client.remove(outputs);
 
     const detail = await client.cls.getLogset({

__tests__/cns.test.js

@@ -1,4 +1,4 @@
-const { Cns } = require('../src');
+const { Cns } = require('../lib');
 
 describe('Cns', () => {
   const credentials = {

__tests__/cos.test.js

@@ -1,4 +1,4 @@
-const { Cos } = require('../src');
+const { Cos } = require('../lib');
 const path = require('path');
 const axios = require('axios');
 const { sleep } = require('@ygkit/request');
@@ -80,7 +80,8 @@ describe('Cos', () => {
 
   test('should deploy website success', async () => {
     const res = await cos.website(websiteInputs);
-    await sleep(1000);
+
+    await sleep(2000);
     const websiteUrl = `${inputs.bucket}.cos-website.${process.env.REGION}.myqcloud.com`;
     const reqUrl = `${websiteInputs.protocol}://${websiteUrl}`;
     const { data } = await axios.get(reqUrl);
@@ -96,7 +97,9 @@ describe('Cos', () => {
 
   test('should deploy website and error code with 200', async () => {
     websiteInputs.disableErrorStatus = true;
+
     const res = await cos.website(websiteInputs);
+
     await sleep(1000);
     const websiteUrl = `${inputs.bucket}.cos-website.${process.env.REGION}.myqcloud.com`;
     const reqUrl = `${websiteInputs.protocol}://${websiteUrl}`;

__tests__/cynosdb.test.js

@@ -1,10 +1,10 @@
-const { Cynosdb } = require('../src');
+const { Cynosdb } = require('../lib');
 const {
   getClusterDetail,
   sleep,
   generatePwd,
   isValidPwd,
-} = require('../src/modules/cynosdb/utils');
+} = require('../lib/modules/cynosdb/utils');
 
 describe('Cynosdb', () => {
   jest.setTimeout(600000);
@@ -123,7 +123,7 @@ describe('Cynosdb', () => {
       zone: inputs.zone,
       vpcConfig: inputs.vpcConfig,
       instanceCount: 1,
-      // adminPassword: expect.stringMatching(pwdReg),
+      // adminPassword: expect.any(String),
       clusterId: expect.stringContaining('cynosdbmysql-'),
       minCpu: 0.5,
       maxCpu: 2,
@@ -158,7 +158,7 @@ describe('Cynosdb', () => {
       zone: inputs.zone,
       vpcConfig: inputs.vpcConfig,
       instanceCount: 1,
-      // adminPassword: expect.stringMatching(pwdReg),
+      // adminPassword: expect.any(String),
       clusterId: expect.stringContaining('cynosdbmysql-'),
       minCpu: 0.5,
       maxCpu: 2,

__tests__/domain.test.js

@@ -1,4 +1,4 @@
-const { Domain } = require('../src');
+const { Domain } = require('../lib');
 
 describe('Domain', () => {
   const credentials = {

__tests__/error.test.js

@@ -1,9 +1,9 @@
-const { TypeError, ApiError } = require('../src/utils/error');
+const { ApiTypeError, ApiError } = require('../lib/utils/error');
 
 describe('Custom Error', () => {
   test('TypeError', async () => {
     try {
-      throw new TypeError(
+      throw new ApiTypeError(
         'TEST_TypeError',
         'This is a test error',
         'error stack',

__tests__/layer.test.js

@@ -1,5 +1,5 @@
 const { sleep } = require('@ygkit/request');
-const { Layer } = require('../src');
+const { Layer } = require('../lib');
 
 describe('Layer', () => {
   const credentials = {
@@ -33,7 +33,7 @@ describe('Layer', () => {
   });
 
   test('should remove layer success', async () => {
-    await sleep(1000);
+    await sleep(5000);
     await layer.remove({
       name: inputs.name,
       version: inputs.version,

__tests__/metrics.test.js

@@ -1,4 +1,4 @@
-const { Metrics } = require('../src');
+const { Metrics } = require('../lib');
 
 describe('Metrics', () => {
   const credentials = {

__tests__/pg.test.js

@@ -1,5 +1,6 @@
-const { Postgresql } = require('../src');
-const { getDbInstanceDetail, sleep } = require('../src/modules/postgresql/utils');
+const { Postgresql } = require('../lib');
+const { getDbInstanceDetail } = require('../lib/modules/postgresql/utils');
+const { sleep } = require('@ygkit/request');
 
 describe('Postgresql', () => {
   const credentials = {

__tests__/scf.test.js

@@ -1,5 +1,5 @@
 const { sleep } = require('@ygkit/request');
-const { Scf, Cfs, Layer } = require('../src');
+const { Scf, Cfs, Layer } = require('../lib');
 
 describe('Scf', () => {
   const credentials = {
@@ -141,6 +141,7 @@ describe('Scf', () => {
   });
 
   afterAll(async (done) => {
+    sleep(2000);
     await cfs.remove({
       fsName: cfsInputs.fsName,
       fileSystemId: inputs.cfs[0].cfsId,
@@ -149,6 +150,10 @@ describe('Scf', () => {
     done();
   });
 
+  /**
+   * FIXME: MPS bind always fail
+   * trigger has already binded (reqId: 62963b70-6875-47b4-ae72-9db54b9ffeba)
+   */
   test('should deploy SCF success', async () => {
     outputs = await scf.deploy(inputs);
     expect(outputs).toEqual({

__tests__/tag.test.js

@@ -1,4 +1,4 @@
-const { Tag } = require('../src');
+const { Tag } = require('../lib');
 
 describe('Tag', () => {
   const credentials = {

__tests__/triggers/cls.test.js

@@ -1,14 +1,15 @@
-const { Cls, Scf } = require('../../src');
-const ClsTrigger = require('../../src/modules/triggers/cls');
+const { Cls, Scf } = require('../../lib');
+const ClsTrigger = require('../../lib/modules/triggers/cls').default;
+const { sleep } = require('@ygkit/request');
 
 describe('Cls', () => {
   const credentials = {
     SecretId: process.env.TENCENT_SECRET_ID,
     SecretKey: process.env.TENCENT_SECRET_KEY,
   };
-  const client = new ClsTrigger({ credentials, region: process.env.REGION });
-  const clsClient = new Cls(credentials, process.env.REGION);
-  const scfClient = new Scf(credentials, process.env.REGION);
+  const clsTrigger = new ClsTrigger({ credentials, region: process.env.REGION });
+  const cls = new Cls(credentials, process.env.REGION);
+  const scf = new Scf(credentials, process.env.REGION);
 
   const data = {
     qualifier: '$DEFAULT',
@@ -41,22 +42,25 @@ describe('Cls', () => {
   let clsOutputs;
 
   beforeAll(async () => {
-    clsOutputs = await clsClient.deploy(clsInputs);
+    clsOutputs = await cls.deploy(clsInputs);
     data.topicId = clsOutputs.topicId;
   });
 
   afterAll(async () => {
-    await clsClient.remove(clsOutputs);
+    await sleep(2000);
+    await cls.remove(clsOutputs);
   });
 
   test('should create trigger success', async () => {
-    const res = await client.create({
+    sleep(2000);
+    const res = await clsTrigger.create({
       inputs: {
         namespace: namespace,
         functionName: functionName,
         parameters: data,
       },
     });
+
     expect(res).toEqual({
       namespace: namespace,
       functionName: functionName,
@@ -68,8 +72,9 @@ describe('Cls', () => {
   });
 
   test('should enable trigger success', async () => {
+    sleep(2000);
     data.enable = true;
-    const res = await client.create({
+    const res = await clsTrigger.create({
       inputs: {
         namespace: namespace,
         functionName: functionName,
@@ -88,8 +93,9 @@ describe('Cls', () => {
   });
 
   test('should disable trigger success', async () => {
+    await sleep(2000);
     data.enable = false;
-    const res = await client.create({
+    const res = await clsTrigger.create({
       inputs: {
         namespace: namespace,
         functionName: functionName,
@@ -108,15 +114,16 @@ describe('Cls', () => {
   });
 
   test('should delete trigger success', async () => {
-    const { Triggers = [] } = await scfClient.request({
+    await sleep(5000);
+    const { Triggers = [] } = await scf.request({
       Action: 'ListTriggers',
       Namespace: namespace,
       FunctionName: functionName,
       Limit: 100,
     });
     const [exist] = Triggers.filter((item) => item.ResourceId.indexOf(`topic_id/${data.topicId}`));
-    const res = await client.delete({
-      scf: scfClient,
+    const res = await clsTrigger.delete({
+      scf: scf,
       inputs: {
         namespace: namespace,
         functionName: functionName,
@@ -128,7 +135,7 @@ describe('Cls', () => {
     });
     expect(res).toEqual({ requestId: expect.any(String), success: true });
 
-    const detail = await client.get({
+    const detail = await clsTrigger.get({
       topicId: data.topicId,
     });
     expect(detail).toBeUndefined();

__tests__/triggers/mps.test.js

@@ -1,6 +1,7 @@
-const { Scf } = require('../../src');
-const MpsTrigger = require('../../src/modules/triggers/mps');
+const { Scf } = require('../../lib');
+const MpsTrigger = require('../../lib/modules/triggers/mps').default;
 
+// FIXME: all mps trigger bind fail
 describe('Mps', () => {
   const credentials = {
     SecretId: process.env.TENCENT_SECRET_ID,