lesgo 0.7.0 → 0.7.4

package/bin/lesgo-scripts.sh

@@ -8,7 +8,7 @@ set -Eeuo pipefail
 #                                                                             #
 ###############################################################################
 
-usage="$(basename "$0") [-f] [-s] [-t] [-h] [-d] [-y] -- script to deploy serverless functions
+usage="$(basename "$0") [-f] [-s] [-t] [-h] [-d] [-c] [-y] -- script to deploy serverless functions
 
 where:
     -t      define the type of action to be taken (build, deploy, invoke, logs, destroy)
@@ -17,22 +17,24 @@ where:
     -h      show this help text
     -l      to invoke a local function
     -d      set data parameters for invoke function
+    -c      set config as per --config path-to-serverless-yml
     -y      no question/prompt for ci/cd"
 
 # arg options
-BUILD=0;        # serverless build without deploy
-DEPLOY=0;       # serverless deploy
-INVOKE=0;       # serverless invoke of specific function
-LOGS=0;         # serverless stream log of specific function
-DESTROY=0;      # serverless remove entire service
-FUNCTION='';    # specify function to involve
-STAGE='';       # deploy specific stage/environment
-INVOKE_LOCAL=0; # default to non local execution
-DATA=''         # set the data parameters for invoke function
-NO_QUESTION=0;  # default to prompt
+BUILD=0;                    # serverless build without deploy
+DEPLOY=0;                   # serverless deploy
+INVOKE=0;                   # serverless invoke of specific function
+LOGS=0;                     # serverless stream log of specific function
+DESTROY=0;                  # serverless remove entire service
+FUNCTION='';                # specify function to involve
+STAGE='';                   # deploy specific stage/environment
+INVOKE_LOCAL=0;             # default to non local execution
+DATA=''                     # set the data parameters for invoke function
+NO_QUESTION=0;              # default to prompt
+CONFIG='./serverless.yml';  # specify serverless config file to deploy, default to root
 
 # parse the options
-while getopts "lhs:f:t:d:y" OPT ; do
+while getopts "lhs:f:t:d:c:y" OPT ; do
   case ${OPT} in
     f) FUNCTION=${OPTARG} ;;
     s) STAGE=${OPTARG} ;;
@@ -53,6 +55,7 @@ while getopts "lhs:f:t:d:y" OPT ; do
         fi;;
     l) INVOKE_LOCAL=1 ;;
     d) DATA=${OPTARG} ;;
+    c) CONFIG=${OPTARG} ;;
     y) NO_QUESTION=1 ;;
     h)
         echo "${usage}"
@@ -102,8 +105,8 @@ function deploy_func_check ()
 
 function deploy_func ()
 {
-    echo -e "${YELLOW}Deploying ${FUNCTION} to ${STAGE}${NC}"
-    sls deploy -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE}
+    echo -e "${YELLOW}Deploying ${FUNCTION} to ${STAGE}${NC} using ${CONFIG}"
+    sls deploy -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE} --config ${CONFIG}
 }
 
 function prompt_confirmation_deploy_all ()
@@ -112,7 +115,7 @@ function prompt_confirmation_deploy_all ()
         deploy_full;
     else
         while true; do
-            read -p "Confirm deploy service to ${STAGE} with .env.${ENVFILE}? [Y|N] " yn
+            read -p "Confirm deploy service to ${STAGE} with .env.${ENVFILE} using ${CONFIG}? [Y|N] " yn
             case ${yn} in
                 [Yy] | yes | Yes | YES ) deploy_full; break;;
                 [Nn] | no | No | NO ) echo -e "${YELLOW}Cancelled deploying service to [${STAGE}]${NC}"; exit;;
@@ -125,7 +128,7 @@ function prompt_confirmation_deploy_all ()
 function prompt_confirmation_deploy_function ()
 {
     while true; do
-        read -p "Confirm deploy function ${FUNCTION} to ${STAGE} with .env.${ENVFILE}? [Y|N] " yn
+        read -p "Confirm deploy function ${FUNCTION} to ${STAGE} with .env.${ENVFILE} using ${CONFIG}? [Y|N] " yn
         case ${yn} in
             [Yy] | yes | Yes | YES ) deploy_func; break;;
             [Nn] | no | No | NO ) echo -e "${YELLOW}Cancelled deploying function ${FUNCTION} to [${STAGE}]${NC}"; exit;;
@@ -137,35 +140,35 @@ function prompt_confirmation_deploy_function ()
 function deploy_full ()
 {
     echo -e "${YELLOW}Deploying service to ${STAGE}${NC}"
-    sls deploy --stage ${STAGE} --env ${ENVFILE}
+    sls deploy --stage ${STAGE} --env ${ENVFILE} --config ${CONFIG}
 }
 
 function invoke_func ()
 {
-    echo -e "${YELLOW}Invoking function ${FUNCTION} on ${STAGE}${NC}"
+    echo -e "${YELLOW}Invoking function ${FUNCTION} on ${STAGE}${NC} using ${CONFIG}"
     if [ ${INVOKE_LOCAL} == 1 ]; then
-        sls invoke local -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE} -d ${DATA} -l
+        sls invoke local -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE} -d ${DATA} -l --config ${CONFIG}
     else
-        sls invoke -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE} -d ${DATA} -l
+        sls invoke -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE} -d ${DATA} -l --config ${CONFIG}
     fi
 }
 
 function log_stream_func ()
 {
-    echo -e "${YELLOW}Log Streaming function ${FUNCTION} on ${STAGE}${NC}"
-    sls logs -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE} -t
+    echo -e "${YELLOW}Log Streaming function ${FUNCTION} on ${STAGE}${NC} using ${CONFIG}"
+    sls logs -f ${FUNCTION} --stage ${STAGE} --env ${ENVFILE} -t --config ${CONFIG}
 }
 
 function build ()
 {
-    echo -e "${YELLOW}Building bundle without deployment${NC}"
-    sls webpack --stage ${STAGE} --env ${ENVFILE}
+    echo -e "${YELLOW}Building bundle without deployment${NC} using ${CONFIG}"
+    sls webpack --stage ${STAGE} --env ${ENVFILE} --config ${CONFIG}
 }
 
 function prompt_confirmation_destroy_service ()
 {
     while true; do
-        read -p "Confirm destroy service to ${STAGE} with .env.${ENVFILE}? Note: This action will remove entire service from AWS. Ensure no other applications are using this service. [Y|N] " yn
+        read -p "Confirm destroy service to ${STAGE} with .env.${ENVFILE} using ${CONFIG}? Note: This action will remove entire service from AWS. Ensure no other applications are using this service. [Y|N] " yn
         case ${yn} in
             [Yy] | yes | Yes | YES ) destroy_service; break;;
             [Nn] | no | No | NO ) echo -e "${YELLOW}Cancelled destroying service to [${STAGE}]${NC}"; exit;;
@@ -177,7 +180,7 @@ function prompt_confirmation_destroy_service ()
 function destroy_service ()
 {
     echo -e "${YELLOW}Removing service to ${STAGE}${NC}"
-    sls remove --stage ${STAGE} --env ${ENVFILE}
+    sls remove --stage ${STAGE} --env ${ENVFILE} --config ${CONFIG}
 }
 
 ###############################################################################

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lesgo",
-  "version": "0.7.0",
+  "version": "0.7.4",
   "description": "Core framework for lesgo node.js serverless framework.",
   "main": "./src/index.js",
   "author": "Sufiyan Rahmat",
@@ -51,7 +51,7 @@
     "prettier": "^1.18.2"
   },
   "dependencies": {
-    "@elastic/elasticsearch": "^7.4.0",
+    "@elastic/elasticsearch": "^7.16.0",
     "@firebase/app": "^0.6.12",
     "data-api-client": "^1.1.0",
     "firebase-admin": "^9.3.0",

package/src/services/ElasticsearchService.js

@@ -38,24 +38,18 @@ class ElasticsearchService {
     return this.client;
   }
 
-  search(body) {
-    return new Promise((resolve, reject) => {
-      const param = {
-        index: this.index,
-        type: this.type,
-        body,
-      };
-      this.client.search(param, (err, response) => {
-        /* istanbul ignore next */
-        if (err) {
-          reject(err);
-        }
-
-        this.result = response;
-
-        resolve(response);
-      });
-    });
+  async search(body) {
+    const param = {
+      index: this.index,
+      type: this.type,
+      body,
+    };
+
+    const response = await this.client.search(param);
+
+    this.result = response;
+
+    return response;
   }
 
   /**
@@ -75,12 +69,7 @@ class ElasticsearchService {
       body: settings,
     };
 
-    return new Promise((resolve, reject) => {
-      this.client.indices.create(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response);
-      });
-    });
+    return this.client.indices.create(params);
   }
 
   deleteIndices(index, options = {}) {
@@ -89,32 +78,20 @@ class ElasticsearchService {
       ...options,
     };
 
-    return new Promise((resolve, reject) => {
-      this.client.indices.delete(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response);
-      });
-    });
+    return this.client.indices.delete(params);
   }
 
-  existIndices(index, options = {}) {
+  async existIndices(index, options = {}) {
     const params = { index, ...options };
-    return new Promise((resolve, reject) => {
-      this.client.indices.exists(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response.body);
-      });
-    });
+
+    const response = await this.client.indices.exists(params);
+    return response.body;
   }
 
   putMapping(index, type, body) {
     const params = { index, type, body: { properties: body } };
-    return new Promise((resolve, reject) => {
-      this.client.indices.putMapping(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response);
-      });
-    });
+
+    return this.client.indices.putMapping(params);
   }
 
   get(id) {
@@ -124,12 +101,7 @@ class ElasticsearchService {
       id,
     };
 
-    return new Promise((resolve, reject) => {
-      this.client.get(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response);
-      });
-    });
+    return this.client.get(params);
   }
 
   indexOrCreateById(body, refresh = false) {
@@ -141,24 +113,11 @@ class ElasticsearchService {
       refresh,
     };
 
-    return new Promise((resolve, reject) => {
-      this.client.index(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response);
-      });
-    });
+    return this.client.index(params);
   }
 
   bulkIndex(bodies) {
-    return new Promise((resolve, reject) => {
-      this.client.bulk(
-        { body: this.constructBulkIndex(bodies) },
-        (err, response) => {
-          // eslint-disable-next-line no-unused-expressions
-          err ? /* istanbul ignore next */ reject(err) : resolve(response);
-        }
-      );
-    });
+    return this.client.bulk({ body: this.constructBulkIndex(bodies) });
   }
 
   create(id, body) {
@@ -169,12 +128,7 @@ class ElasticsearchService {
       body,
     };
 
-    return new Promise((resolve, reject) => {
-      this.client.index(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response);
-      });
-    });
+    return this.client.index(params);
   }
 
   updateById(id) {
@@ -184,12 +138,7 @@ class ElasticsearchService {
       id,
     };
 
-    return new Promise((resolve, reject) => {
-      this.client.get(params, (err, response) => {
-        // eslint-disable-next-line no-unused-expressions
-        err ? /* istanbul ignore next */ reject(err) : resolve(response);
-      });
-    });
+    return this.client.get(params);
   }
 
   /**

package/src/services/__tests__/LengthAwarePaginator.spec.js

@@ -32,6 +32,8 @@ describe('test LengthAwarePaginator instantiate', () => {
     expect(await paginator.lastItem()).toMatchObject(mockDataLastItem);
     expect(paginator.perPage()).toEqual(5);
     expect(await paginator.total()).toEqual(30);
+
+    expect(db.select).toHaveBeenCalled();
   });
   it('should not throw exception when instantiating with current page', async () => {
     const paginator = new LengthAwarePaginator(
@@ -51,6 +53,8 @@ describe('test LengthAwarePaginator instantiate', () => {
     expect(await paginator.lastItem()).toMatchObject(mockDataLastItem);
     expect(paginator.perPage()).toEqual(5);
     expect(await paginator.total()).toEqual(30);
+
+    expect(db.select).toHaveBeenCalled();
   });
   it('should default perPage to 10 when instantiating without perPage', async () => {
     const paginator = new LengthAwarePaginator(
@@ -66,6 +70,8 @@ describe('test LengthAwarePaginator instantiate', () => {
     expect(paginator.currentPage()).toEqual(1);
     expect(paginator.perPage()).toEqual(10);
     expect(await paginator.total()).toEqual(30);
+
+    expect(db.select).toHaveBeenCalled();
   });
   it('should throw exception if total is not a number', async () => {
     try {
@@ -116,6 +122,43 @@ describe('test LengthAwarePaginator instantiate', () => {
         { ...mockDataLastItem },
       ],
     });
+
+    expect(db.select).toHaveBeenCalled();
+  });
+
+  it('should simply return an empty paginator object if total is explicitly zero', async () => {
+    const paginator = new LengthAwarePaginator(
+      db,
+      'SELECT * FROM tests',
+      {},
+      {
+        perPage: 5,
+        currentPage: 1,
+        total: 0,
+      }
+    );
+
+    expect(await paginator.count()).toEqual(0);
+    expect(await paginator.previousPage()).toEqual(false);
+    expect(paginator.currentPage()).toEqual(1);
+    expect(await paginator.nextPage()).toEqual(false);
+    expect(await paginator.firstItem()).toBe(undefined);
+    expect(await paginator.lastItem()).toBe(undefined);
+    expect(paginator.perPage()).toEqual(5);
+    expect(await paginator.total()).toEqual(0);
+
+    expect(await paginator.toObject()).toMatchObject({
+      count: 0,
+      previous_page: false,
+      current_page: 1,
+      next_page: false,
+      per_page: 5,
+      last_page: 0,
+      total: 0,
+      items: [],
+    });
+
+    expect(db.select).not.toHaveBeenCalled();
   });
 });
 
@@ -138,7 +181,7 @@ describe('test total() usage', () => {
 });
 
 describe('test lastPage() usage', () => {
-  it('should get the last page using supplied paramater as total data', async () => {
+  it('should get the last page using supplied parameter as total data', async () => {
     const paginator1 = new LengthAwarePaginator(
       db,
       'SELECT * FROM total_tests',

package/src/services/pagination/Paginator.js

@@ -217,11 +217,17 @@ export default class Paginator {
   }
 
   async executeQuery() {
-    this.response = await this.dbProp.select(
-      this.generatePaginationSqlSnippet(),
-      this.sqlParamsProp,
-      this.connection
-    );
+    const total = this.totalProp;
+    if (
+      (typeof total === 'number' && total > 0) ||
+      (typeof total !== 'number' && !total)
+    ) {
+      this.response = await this.dbProp.select(
+        this.generatePaginationSqlSnippet(),
+        this.sqlParamsProp,
+        this.connection
+      );
+    }
 
     this.hasNext = this.response.length > this.perPage();
     if (this.hasNext) {