axe-api 0.17.1 → 0.17.5

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+## How has this been tested?
+
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, tests ran to see how -->
+<!--- your change affects other areas of the code, etc. -->
+
+## Types of changes
+
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklist:
+
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] My changes requires documentation change.
+- [ ] The changes have been documented in the [axe-api/docs](https://github.com/axe-api/docs) repository. (<!--- Please insert the PR link -->)
+- [ ] I added integration tests properly.
+- [ ] The changes require [axe-api-template](https://github.com/axe-api/axe-api-template) changes. (<!--- Please insert the PR link -->)

package/.github/workflows/auto-tag.yml

@@ -0,0 +1,15 @@
+name: Create Tag
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: butlerlogic/action-autotag@stable
+        with:
+          GITHUB_TOKEN: "${{ secrets.AUTO_TAG_TOKEN }}"

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Release Notes
 
+## [0.17.5 (2021-11-27)](https://github.com/axe-api/axe-api/compare/0.17.5...0.17.4)
+
+### Fixed
+
+- [#111](https://github.com/axe-api/axe-api/issues/111)
+
+## [0.17.4 (2021-10-28)](https://github.com/axe-api/axe-api/compare/0.17.4...0.17.3)
+
+### Fixed
+
+- [#97](https://github.com/axe-api/axe-api/issues/97)
+- [#104](https://github.com/axe-api/axe-api/issues/104)
+
+## [0.17.3 (2021-10-28)](https://github.com/axe-api/axe-api/compare/0.17.3...0.17.2)
+
+### Fixed
+
+- [#98](https://github.com/axe-api/axe-api/issues/98)
+
+## [0.17.2 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.2...0.17.1)
+
+### Fixed
+
+- Fixed table join on the related table filter.
+
 ## [0.17.1 (2021-10-17)](https://github.com/axe-api/axe-api/compare/0.17.1...0.17.0)
 
 ### Fixed

package/index.js

@@ -1,7 +1,12 @@
 import Server from "./src/Server.js";
 import Model from "./src/core/Model.js";
 import IoC from "./src/core/IoC.js";
-import { LOG_LEVEL, HOOK_FUNCTIONS, HANDLERS } from "./src/constants.js";
+import {
+  LOG_LEVEL,
+  HOOK_FUNCTIONS,
+  HANDLERS,
+  DEFAULT_HANDLERS,
+} from "./src/constants.js";
 import HttpResponse from "./src/core/HttpResponse.js";
 
 export {
@@ -12,4 +17,5 @@ export {
   LOG_LEVEL,
   HOOK_FUNCTIONS,
   HANDLERS,
+  DEFAULT_HANDLERS,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-api",
-  "version": "0.17.1",
+  "version": "0.17.5",
   "description": "AXE API is a simple tool which has been created based on Express and Knex.js to create Rest APIs quickly.",
   "main": "index.js",
   "type": "module",
@@ -22,9 +22,9 @@
     "change-case": "^4.1.2",
     "dotenv": "^10.0.0",
     "express": "^4.17.1",
-    "knex": "^0.95.11",
-    "knex-paginate": "^2.3.0",
-    "knex-schema-inspector": "^1.6.2",
+    "knex": "^0.95.12",
+    "knex-paginate": "^3.0.0",
+    "knex-schema-inspector": "^1.6.4",
     "pluralize": "^8.0.0",
     "validatorjs": "^3.22.1"
   },

package/readme.md

@@ -39,6 +39,30 @@ Fastest way to create simple Rest API by defining database models and relations.
 - Multiple database support (Postgres, MSSQL, MySQL, MariaDB, SQLite3, Oracle, and Amazon Redshift)
 - Well documented
 
+## How To Run Integration Tests
+
+> You have to have **Docker** and **Docker Compose** on your local development environment to run integration tests.
+
+Execute the following commands to prepare the integration app
+
+```sh
+cd tests/integrations && npm install && npm ci && npm run build --if-present
+```
+
+Execute the following commands to prepare the database;
+
+```sh
+docker-compose -f "./tests/integrations/docker-compose.mysql8.yml" up -d --build
+```
+
+> To down the database, you can use the following command; `docker-compose -f "./tests/integrations/docker-compose.mysql8.yml" up -d --build`
+
+You can execute the following command to execute tests;
+
+```sh
+npm run test:integration:mysql8
+```
+
 ## License
 
 [MIT License](LICENSE)

package/src/constants.js

@@ -55,6 +55,14 @@ const HANDLERS = {
   AUTOSAVE: "autosave",
 };
 
+const DEFAULT_HANDLERS = [
+  HANDLERS.INSERT,
+  HANDLERS.PAGINATE,
+  HANDLERS.SHOW,
+  HANDLERS.UPDATE,
+  HANDLERS.DELETE,
+];
+
 const HTTP_METHODS = {
   POST: "POST",
   GET: "GET",
@@ -125,5 +133,6 @@ export {
   LOG_COLORS,
   DEPENDECY_TYPES,
   HANDLERS,
+  DEFAULT_HANDLERS,
   TIMESTAMP_COLUMNS,
 };

package/src/core/QueryParser.js

@@ -55,7 +55,7 @@ class QueryParser {
     });
   }
 
-  applyWheresInsideGroup(query, sub, ruleSet) {
+  applyWheresInsideGroup(sub, ruleSet) {
     // If there is not any query, we don't have to filter the data.
     if (!ruleSet) {
       return;
@@ -65,7 +65,7 @@ class QueryParser {
       for (const item of ruleSet) {
         // If the item is not an array, it means that it is a standard condition
         if (Array.isArray(item) === false) {
-          this._applyConditionRule(query, sub, item);
+          this._applyConditionRule(sub, item);
         } else {
           // If the item is an array, we should create the query recursively.
           if (item[0].prefix === "or") {
@@ -80,14 +80,16 @@ class QueryParser {
         }
       }
     } else {
-      this._applyConditionRule(query, sub, ruleSet);
+      this._applyConditionRule(sub, ruleSet);
     }
   }
 
   applyWheres(query, ruleSet) {
     query.where((sub) => {
-      this.applyWheresInsideGroup(query, sub, ruleSet);
+      this.applyWheresInsideGroup(sub, ruleSet);
     });
+
+    this._applyRelatedQueryJoins(query, ruleSet);
   }
 
   get(query) {
@@ -124,15 +126,12 @@ class QueryParser {
     ];
   }
 
-  _applyConditionRule(query, sub, ruleSet) {
+  _applyConditionRule(sub, ruleSet) {
     const method = this._getConditionMethodName(ruleSet);
     const zeroArguments = ["Null", "NotNull"];
     const oneArguments = ["In", "NotIn", "Between", "NotBetween"];
 
     const fullFieldPath = `${ruleSet.table}.${ruleSet.field}`;
-    if (ruleSet.table !== this.model.instance.table) {
-      this._addJoinOnce(query, ruleSet);
-    }
 
     if (zeroArguments.indexOf(ruleSet.condition) > -1) {
       return sub[`${method}${ruleSet.condition}`](fullFieldPath);
@@ -145,6 +144,31 @@ class QueryParser {
     return sub[method](fullFieldPath, ruleSet.condition, ruleSet.value);
   }
 
+  _applyRelatedQueryJoins(query, ruleSet) {
+    if (!ruleSet) {
+      return;
+    }
+
+    if (Array.isArray(ruleSet)) {
+      for (const item of ruleSet) {
+        // If the item is not an array, it means that it is a standard condition
+        if (Array.isArray(item) === false) {
+          this._applyJoinIfNecessary(query, item);
+        } else {
+          this._applyRelatedQueryJoins(query, item);
+        }
+      }
+    } else {
+      this._applyJoinIfNecessary(query, ruleSet);
+    }
+  }
+
+  _applyJoinIfNecessary(query, ruleSet) {
+    if (ruleSet.table !== this.model.instance.table) {
+      this._addJoinOnce(query, ruleSet);
+    }
+  }
+
   _addJoinOnce(query, { model, relation }) {
     if (this.createdJoins.includes(relation.name)) {
       return;

package/src/handlers/autosave.js

@@ -78,7 +78,7 @@ export default async (context) => {
   });
 
   // Serializing the data by the model's serialize method
-  item = serializeData(item, model.instance.serialize);
+  item = await serializeData(item, model.instance.serialize);
 
   // Filtering hidden fields from the response data.
   filterHiddenFields([item], model.instance.hiddens);

package/src/resolvers/setExpressRoutes.js

@@ -1,29 +1,11 @@
 import IoC from "./../core/IoC.js";
 import pluralize from "pluralize";
+import { paramCase } from "change-case";
 import { RELATIONSHIPS, API_ROUTE_TEMPLATES } from "./../constants.js";
 import Handlers from "./../handlers/index.js";
 
 let Config = null;
 
-const handleErrors = (req, res, error) => {
-  const status = error.type === "HttpResponse" ? error.status : 400;
-  let errors = error.content ? error.content : error.message;
-
-  if (Config.Application.env === "production") {
-    errors = "An error occurred!";
-  }
-
-  const result = {
-    errors,
-  };
-
-  if (Config.Application.env === "development") {
-    result.stack = error.stack;
-  }
-
-  res.status(status).json(result);
-};
-
 const setTransactionOption = (option, handler, defaultValue) => {
   if (Array.isArray(option)) {
     if (option.some((i) => i.handler === handler)) {
@@ -52,7 +34,7 @@ const hasTransaction = (config, model, handler) => {
   return privilegedOption;
 };
 
-const requestHandler = async (handler, req, res, context) => {
+const requestHandler = async (handler, req, res, next, context) => {
   try {
     context.trx = context.database;
     if (hasTransaction(Config, context.model, handler)) {
@@ -72,7 +54,7 @@ const requestHandler = async (handler, req, res, context) => {
       await context.trx.rollback();
     }
 
-    handleErrors(req, res, error);
+    next(error);
   }
 };
 
@@ -83,7 +65,7 @@ const ucFirst = (string) => {
 const getResourcePath = (model, relation) => {
   return relation
     ? relation.resource
-    : pluralize.plural(model.name).toLowerCase();
+    : paramCase(pluralize.plural(model.name)).toLowerCase();
 };
 
 const getPrimaryKeyName = (model) => {
@@ -228,9 +210,13 @@ const createRouteByModel = async (
     docs.push(routeTemplate.method, url, model);
 
     // Adding the route to the express
-    app[routeTemplate.method.toLowerCase()](url, middlewares, (req, res) => {
-      requestHandler(handler, req, res, context);
-    });
+    app[routeTemplate.method.toLowerCase()](
+      url,
+      middlewares,
+      (req, res, next) => {
+        requestHandler(handler, req, res, next, context);
+      }
+    );
   }
 
   await createChildRoutes(model, models, resource, urlPrefix);