chore: merge origin/master

Author: Guillaume Gautreau

.github/workflows/build.yml

@@ -39,8 +39,6 @@ jobs:
     needs: [lint]
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
       - uses: actions/setup-node@v1
       - name: Cache node_modules
         uses: actions/cache@v2

CHANGELOG.md

@@ -1,5 +1,29 @@
-# [7.0.0-beta.10](https://github.com/ForestAdmin/forest-express-sequelize/compare/v7.0.0-beta.9...v7.0.0-beta.10) (2021-02-09)
+## [6.7.10](https://github.com/ForestAdmin/forest-express-sequelize/compare/v6.7.9...v6.7.10) (2021-02-22)
+
+
+### Bug Fixes
+
+* support foreign and primary key column ([#630](https://github.com/ForestAdmin/forest-express-sequelize/issues/630)) ([2a289b8](https://github.com/ForestAdmin/forest-express-sequelize/commit/2a289b805727d51d112719ee29af28b7745bff73))
+
+## [6.7.9](https://github.com/ForestAdmin/forest-express-sequelize/compare/v6.7.8...v6.7.9) (2021-02-22)
+
+
+### Bug Fixes
+
+* fix record creation with unconventional pk field acting as a fk ([#598](https://github.com/ForestAdmin/forest-express-sequelize/issues/598)) ([d3779b7](https://github.com/ForestAdmin/forest-express-sequelize/commit/d3779b75f553830574c51850dfdec5c6ab3eabc6))
+
+## [6.7.8](https://github.com/ForestAdmin/forest-express-sequelize/compare/v6.7.7...v6.7.8) (2021-02-19)
+
 
+### Bug Fixes
+
+* **search:** don't convert float values to bigint ([75c1517](https://github.com/ForestAdmin/forest-express-sequelize/commit/75c151720bb9c260272325f1f2c088b0c9050ac7))
+* **search:** handle large numbers in search queries ([c0c1c70](https://github.com/ForestAdmin/forest-express-sequelize/commit/c0c1c70686ecdaab9c9e6bbf432f44a414cf8c2e))
+* **search:** handle large numbers in search queries ([#621](https://github.com/ForestAdmin/forest-express-sequelize/issues/621)) ([ec6ab89](https://github.com/ForestAdmin/forest-express-sequelize/commit/ec6ab8989cde26af379f814fa7ee4bd28a1cddd6))
+* **search:** handle tables that contain floats and bigints ([7ac2fe1](https://github.com/ForestAdmin/forest-express-sequelize/commit/7ac2fe152ae01af98484d88e8c98c612bcb50573))
+* **search:** revert changes when numbers are below MAX_SAFE_INTEGER ([1d95021](https://github.com/ForestAdmin/forest-express-sequelize/commit/1d95021f55a64a519d71c301ceb810196abfdd34))
+
+# [7.0.0-beta.10](https://github.com/ForestAdmin/forest-express-sequelize/compare/v7.0.0-beta.9...v7.0.0-beta.10) (2021-02-09)
 
 ### Bug Fixes
 

README.md

@@ -1,6 +1,7 @@
 # Forest Admin in Nodejs (Express.js & Sequelize)
+
 [![npm package](https://badge.fury.io/js/forest-express-sequelize.svg)](https://badge.fury.io/js/forest-express-sequelize)
-[![CI status](https://github.com/ForestAdmin/forest-express-sequelize/workflows/.github/workflows/build.yml/badge.svg)](https://github.com/ForestAdmin/forest-express-sequelize/actions)
+[![CI status](https://github.com/ForestAdmin/forest-express-sequelize/workflows/Build,%20Test%20and%20Deploy/badge.svg?branch=master)](https://github.com/ForestAdmin/forest-express-sequelize/actions)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/42d6d0fce013a6b96ae2/test_coverage)](https://codeclimate.com/github/ForestAdmin/forest-express-sequelize/test_coverage)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
@@ -9,6 +10,7 @@ Forest Admin provides an off-the-shelf administration panel based on a highly-ex
 This project has been designed with scalability in mind to fit requirements from small projects to mature companies.
 
 ## Who Uses Forest Admin
+
 - [Apartmentlist](https://www.apartmentlist.com)
 - [Carbon Health](https://carbonhealth.com)
 - [Ebanx](https://www.ebanx.com)
@@ -22,9 +24,11 @@ This project has been designed with scalability in mind to fit requirements from
 - And hundreds more…
 
 ## Getting started
+
 [https://docs.forestadmin.com/documentation/getting-started/installation](https://docs.forestadmin.com/documentation/getting-started/installation)
 
 ## Documentation
+
 [https://docs.forestadmin.com/documentation/](https://docs.forestadmin.com/documentation/)
 
 ## How it works
@@ -34,6 +38,7 @@ This project has been designed with scalability in mind to fit requirements from
 </p>
 
 Forest Admin consists of two components:
+
 - The Admin Frontend is the user interface where you'll manage your data and configuration.
 - The Admin Backend API hosted on your servers where you can find and extend your data models and all the business logic (routes, actions, …) related to your admin panel.
 
@@ -45,27 +50,31 @@ user and your application data through the Admin API.
 ## Features
 
 ### CRUD
+
 All of your CRUD operations are natively supported. The API automatically
 supports your data models' validation and allows you to easily extend or
 override any API routes' with your very own custom logic.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-CRUD.jpg" alt="CRUD">
 
 ### Search & Filters
+
 Forest Admin has a built-in search allowing you to run basic queries to
 retrieve your application's data. Set advanced filters based on fields and
 relationships to handle complex search use cases.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Search.jpg" alt="Search and Filters">
 
 ### Sorting & Pagination
+
 Sorting and pagination features are natively handled by the Admin API. We're
 continuously optimizing how queries are run in order to display results faster
 and reduce the load of your servers.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Sorting.jpg" alt="Sorting and Pagination">
 
 ### Custom action
+
 A custom action is a button which allows you to trigger an API call to execute
 a custom logic. With virtually no limitations, you can extend the way you
 manipulate data and trigger actions (e.g. refund a customer, apply a coupon,
@@ -74,42 +83,49 @@ ban a user, etc.)
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Custom.jpg" alt="Sorting and Pagination">
 
 ### Export
+
 Sometimes you need to export your data to a good old fashioned CSV. Yes, we
 know this can come in handy sometimes :-)
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Export.jpg" alt="Export">
 
 ### Segments
+
 Get in app access to a subset of your application data by doing a basic search
 or typing an SQL query or implementing an API route.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Segments.jpg" alt="Segments">
 
 ### Dashboards
+
 Forest Admin is able to tap into your actual data to chart out your metrics
 using a simple UI panel, a SQL query or a custom API call.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Dashboard.jpg" alt="Dashboard">
 
 ### WYSIWYG
+
 The WYSIWYG interface saves you a tremendous amount of frontend development
 time using drag'n'drop as well as advanced widgets to build customizable views.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Wysiwyg.jpg" alt="WYSIWYG">
 
 ### Custom HTML/JS/CSS
+
 Code your own views using JS, HTML, and CSS to display your application data in
 a more appropriate way (e.g. Kanban, Map, Calendar, Gallery, etc.).
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-CustomHTML.jpg" alt="Custom views">
 
 ### Team-based permissions
+
 Without any lines of code, manage directly from the UI who has access or can
 act on which data using a team-based permission system.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Teams.jpg" alt="Team based permissions">
 
 ### Third-party integrations
+
 Leverage data from third-party services by reconciling it with your
 application’s data and providing it directly to your Admin Panel. All your
 actions can be performed at the same place, bringing additional intelligence to
@@ -118,12 +134,14 @@ your Admin Panel and ensuring consistency.
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-3rdParty.jpg" alt="Third-party integrations">
 
 ### Notes & Comments
+
 Assign your teammates to specific tasks, leave a note or simply comment a
 record, thereby simplifying collaboration all across your organization.
 
 <img src="https://www.forestadmin.com/public/img/illustrations-dev/screens/ForestWebsite20-Notes.jpg" alt="Notes and Comments">
 
 ### Activity logs
+
 Monitor each action executed and follow the trail of modification on any data
 with an extensive activity log system.
 

src/adapters/sequelize.js

@@ -3,6 +3,7 @@ const P = require('bluebird');
 const Interface = require('forest-express');
 const ApimapFieldBuilder = require('../services/apimap-field-builder');
 const ApimapFieldTypeDetector = require('../services/apimap-field-type-detector');
+const primaryKeyIsForeignKey = require('../utils/primaryKey-is-ForeignKey');
 
 module.exports = (model, opts) => {
   const fields = [];
@@ -82,8 +83,16 @@ module.exports = (model, opts) => {
         idField = 'forestCompositePrimary';
       }
 
+      Object.entries(model.associations).forEach(([, association]) => {
+        const pkIsFk = primaryKeyIsForeignKey(association);
+        if (pkIsFk) {
+          const fk = fields.find((field) => field.reference === `${association.associationAccessor}.${association.foreignKey}`);
+          fk.foreignAndPrimaryKey = true;
+        }
+      });
+
       _.remove(fields, (field) =>
-        _.includes(fieldNamesToExclude, field.columnName) && !field.primaryKey);
+        _.includes(fieldNamesToExclude, field.columnName));
 
       return {
         name: model.name,

src/services/resource-creator.js

@@ -5,6 +5,7 @@ const { ErrorHTTP422 } = require('./errors');
 const ResourceGetter = require('./resource-getter');
 const CompositeKeysManager = require('./composite-keys-manager');
 const associationRecord = require('../utils/association-record');
+const primaryKeyIsForeignKey = require('../utils/primaryKey-is-ForeignKey');
 
 class ResourceCreator {
   constructor(model, params) {
@@ -28,6 +29,10 @@ class ResourceCreator {
     if (association.associationType === 'BelongsTo') {
       const setterName = `set${_.upperFirst(name)}`;
       const targetKey = await this._getTargetKey(name, association);
+      const pkIsFk = primaryKeyIsForeignKey(association);
+      if (pkIsFk) {
+        record[association.source.primaryKeyAttribute] = this.params[name];
+      }
       return record[setterName](targetKey, { save: false });
     }
     return null;

src/services/search-builder.js

@@ -148,8 +148,15 @@ function SearchBuilder(model, opts, params, fieldNamesRequested) {
           pushCondition(condition, columnName);
         }
       } else if (field.type === 'Number') {
-        const value = Number(params.search);
+        let value = Number(params.search);
+
         if (!Number.isNaN(value)) {
+          if (Number.isInteger(value) && !Number.isSafeInteger(value)) {
+            // NOTE: Numbers higher than MAX_SAFE_INTEGER need to be handled as
+            //       strings to circumvent precision problems
+            value = params.search;
+          }
+
           condition[field.field] = value;
           pushCondition(condition, field.field);
         }

src/utils/primaryKey-is-ForeignKey.js

@@ -0,0 +1,3 @@
+module.exports = (association) =>
+  Object.values(association.source.rawAttributes).filter((attr) =>
+    attr.field === association.source.primaryKeyField).length > 1;

test/adapters/sequelize.test.js

@@ -25,6 +25,36 @@ function getField(schema, name) {
     },
   });
 
+  models.customer = sequelize.define('customer', {
+    name: { type: Sequelize.STRING },
+  });
+
+  models.picture = sequelize.define('picture', {
+    name: { type: Sequelize.STRING },
+    customerId: {
+      type: Sequelize.INTEGER,
+      primaryKey: true,
+      allowNull: false,
+    },
+  }, {
+    underscored: true,
+  });
+
+  models.customer.hasOne(models.picture, {
+    foreignKey: {
+      name: 'customerIdKey',
+      field: 'customer_id',
+    },
+    as: 'picture',
+  });
+  models.picture.belongsTo(models.customer, {
+    foreignKey: {
+      name: 'customerIdKey',
+      field: 'customer_id',
+    },
+    as: 'customer',
+  });
+
   describe(`with dialect ${connectionManager.getDialect()} (port: ${connectionManager.getPort()})`, () => {
     describe('with model `users`', () => {
       it('should set name correctly', async () => {
@@ -120,5 +150,14 @@ function getField(schema, name) {
         });
       });
     });
+
+    describe('with association', () => {
+      it('should set foreignAndPrimaryKey to true', async () => {
+        expect.assertions(1);
+
+        const schema = await getSchema(models.picture, sequelizeOptions);
+        expect(schema.fields.find((x) => x.field === 'customer').foreignAndPrimaryKey).toBeTrue();
+      });
+    });
   });
 });