feat: added onconnectioncreate module option

PR Checklist

Please check if your PR fulfills the following requirements:

[x] The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
[x] Tests for the changes have been added (for bug fixes / features)
[ ] Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Other... Please describe:

What is the current behavior?

Issue Number: #1290

// THIS DOES NOT WORK
MongooseModule.forRootAsync({
  imports: [MongoConfigModule],
  useFactory: async (mongoConfigService: MongoConfigService) => {
    return {
      ...mongoConfigService.mongoConfig,
      connectionFactory: (connection: Connection) => {
        connection.on('connected', () => console.log('connected'));
        connection.on('open', () => console.log('open'));
        connection.on('disconnected', () => console.log('disconnected'));
        connection.on('reconnected', () => console.log('reconnected'));
        connection.on('disconnecting', () => console.log('disconnecting'));

        return connection;
      },
    };
  },
  inject: [MongoConfigService],
}),

What is the new behavior?

According to Mongoose Documentation, the event listeners should be added immediately after createConnection. By adding this onConnectionCreate function as a module option, we can bypass the limits of the connectionFactory function.

MongooseModule.forRootAsync({
  imports: [MongoConfigModule],
  useFactory: async (mongoConfigService: MongoConfigService) => {
    return {
      ...mongoConfigService.mongoConfig,
      // Once connection is established
      connectionFactory: (connection: Connection) => {
        connection.plugin(require('mongoose-autopopulate'));

        return connection;
      },
      // Before connection is established and returned as Promise.
      onConnectionCreate: (connection: Connection) => {
        connection.on('connected', () => console.log('connected'));
        connection.on('open', () => console.log('open'));
        connection.on('disconnected', () => console.log('disconnected'));
        connection.on('reconnected', () => console.log('reconnected'));
        connection.on('disconnecting', () => console.log('disconnecting'));

        return connection;
      },
    };
  },
  inject: [MongoConfigService],
}),

The same will work for forRootAsync().

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

I can create the Main Docs PR if changes are approved.

nestjs / mongoose

feat: added onconnectioncreate module option #2096