sequelize: Error: Cannot find module 'pg-native'

The error occurs when calling optClone->lodash.cloneDeep from findOne and other similar methods. The PG-module has a property ‘native’, which is a getter:

module.exports.__defineGetter__("native", function() {
  delete module.exports.native;
  module.exports.native = new PG(require('./native'));
  return module.exports.native;
});

During cloning this getter is called and throwing error.

Workarounds:

1: Before Sequelize initialization in application we can remove stupid getter:

var pg = require('pg');
delete pg.native;

It should be documented.

2: Delete getter when require PG in Sequelize connection-manager.js if config.native === false

3: Or we need to patch Units.clone for totally skipping property ‘lib’ cloning:

   cloneDeep: function(obj, fn) {
-    return lodash.cloneDeep(obj, function (elem) {
+    return lodash.cloneDeep(obj, function (elem, key) {
+      // Skip property 'lib' cloning (PG-native error workaround)
+      if (key === 'lib' && elem.hasOwnProperty('native')) {
+        return elem;
+      }
+

Hi there!

It just happened to me as well but I found why 😉

So first the delete pg.native; didn’t work for me.

What happened in my case is that I have winston as a logger and I was doing something like logger.debug({'fontFromDb': fontFromDb}). The logger tries to log everything and call this getter that shouldn’t be called and 💥

So make sure you don’t have anything like a clone or a logger on an instance. If you need to clone or log do it with a raw: true query that returns a JSON or turn the instance to JSON like this: fontFromDb.toJSON()

I have this problem in 4.37.10 too.

I’ve found the exact line of code which triggers this error me, it’s when I’m comparing a non-persistent Sequelize instance with a regular object using: expect(myObject).to.deep.equal(mySequelizeInstance);, where expect is defined as const { expect } = require('chai');.

I guess the problem arises when Chai’s deep-eql tries to inspect the native getter, or something similar. I get the same problem if I use lodash’s cloneDeep on a Sequelize instance.

So if you have code that inspects/clones a Sequelize instance you could be faced with this problem. For me the workaround was just to make sure that I got a plain object using the instance’s method toJSON before doing any kind of inspection or cloning.

same in version 4.37.6. Please reopen this bug.

Just a word. This issue is 4,5 years ago. I think one could expect a little more than an obscure an not-always-working workaround to fix an issue on a ORM, IMHO. Just to say

Please, This issue is about sequelize models / transactions / whatever-objects messing up with whatever-logging strategy.

Maybe we should try not to polute this thread with workarounds for every-loggers-on-earth. At the end of the day, console.log(sequelizeModel) just messes; the issue is about fixing that.

@superrandres you have pg@7.14.0. Try using pg@8 or above (npm i -s pg@8) and see if the error is still there. I indicated a few post ago that upgrading pg from 7 to 8 solved the issue for me.

From the looks of it, the workaround by tornillo should work for everyone.

const pg = require('pg');
delete pg.native;

Since version 8, the .native getter is no longer enumerable, therefore this problem can be avoided by upgrading to pg 8. For this reason I will close this issue now. If anyone still experiences this problem with pg 8 please let me know and I will reopen this.

However, in principle, it is Sequelize’s fault to deep clone these things to begin with. I’ve opened #13168 to track this.

pg@8 has been released, which contains a (hopefully) fix for this. Is it safe to upgrade though?.. I just ran npm i -s pg@8 and my very basic routes seem to be working fine…

So after reading pg module code, I found that problem with bundling is in index.js file:

if (typeof process.env.NODE_PG_FORCE_NATIVE !== 'undefined') {
  module.exports = new PG(require('./native'))
} else {
  module.exports = new PG(Client)

  // lazy require native module...the native module may not have installed
  module.exports.__defineGetter__('native', function () {
    delete module.exports.native
    var native = null
    try {
      native = new PG(require('./native'))
    } catch (err) {
      if (err.code !== 'MODULE_NOT_FOUND') {
        throw err
      }
      /* eslint-disable no-console */
      console.error(err.message)
      /* eslint-enable no-console */
    }
    module.exports.native = native
    return native
  })

It requires ./native file which is depending on pg-native. So to pack it with webpack we need to ignore this import. To do it just use webpack.IgnorePlugin:

new webpack.IgnorePlugin(/.\/native/),

After this addition, everything works fine.

@jamiesoncj I have the same issue as you and managed to workaround that by changing

    logging: logger.debug.bind(logger),

to

    logging: sql => logger.debug(sql),

No idea why it works, kinda makes no sense.

For me, this error occurred when I tried to put Sequelize instance inside of a Winston logger.

logger.info('getSegmentData', { lastAttempt, previousAttempt });

Fix:

logger.info('getSegmentData', { 
    lastAttempt: lastAttempt ? lastAttempt.get({ plain: true }) : null,
    previousAttempt: previousAttempt ? previousAttempt.get({ plain: true }) : null
});

@1valdis Hmmm, thanks for pinging, I will look into it later

If the failure happens at build time (e.g. when running webpack), and you don’t want to use pg-native, you can add it to webpack’s externals s.t. it doesn’t complain if it can’t find the package.

@papb I’ve been using pg@8 with Sequelize 5 for a month, having Winston as logger, and made a production app on the combo without ever encountering cannot find module 'pg-native'. Can you confirm that? In fact, nothing has broken in Sequelize 5 with pg@8 (and pg changelog suggested there are only very subtle breaking changes), so I think my upgrade was totally worth it.

@anistark I think you answered your own question 😅 hopefully it will be fixed as a side-effect of #11832

Just to add that I see this issue when trying to use the Winston logger too - for example as shown below. Haven’t found an issue in the Winston repo yet.

const transports = [
  new winston.transports.Console({
    json: true,
    colorize: true,
    handleExceptions: true,
    humanReadableUnhandledException: true,
  }),
];

const logger = winston.createLogger({
  level: 'debug',
  transports,
});

const sequelize = new Sequelize(config.databaseUrl, {
    logging: logger.debug.bind(logger),
    dialect: 'postgres',
    pool: {
      max: 5,
      min: 0,
      idle: 10000,
    },
    protocol: 'postgres',
    dialectOptions: {
      ssl: true,
    },
  });

As AlariCode said:

So after reading pg module code, I found that problem with bundling is in index.js file

This is a problem with pg, not Sequelize, and it’s being worked on very recently: see node-postgres#1894 and node-postgres#1992.

From the looks of it, the workaround by tornillo should work for everyone.

const pg = require('pg');
delete pg.native;

Fixed this by not installing pg-native module and sequelize config:

var db = new Sequelize(..., {
  "dialect": "postgres",
  "native": false
});

Made some research about performance drawbacks and found nothing.