craftup / node-mongo-tenant Goto Github PK

Hi there,

I am using .byTenant followed by updateMany in order to execute batch update. Problem is tenant model actually ignores clientId field and execute update on documents regardless tenantId field.

Mongoose has the property immutable for a field. It would be cool to add this option in the plugin.

for example: SomeSchema.plugin(mongoTenant, { ... , immutable: true });

Thanks in advance

Anyone is able to use this library with Typescript?

Hi there.
How to use database level ?

In our gitter channel the question came up if mongo-tenant is compatible with mongoose 5.

see migration guide

• Make sure mongo-tenant is compatible with the latest mongoose major version.
• Adjust tests
• Adjust readme

The project is currently missing release-notes.

• add release-notes.yml file
• publish release notes to the release notes hub
• add badge for linking to the hosted release notes

Story

As a service operator I would like to run all my freemium tenants on a shared database with tenant separation on column level. All my premium customers data should be stored in a dedicated database, maybe even on another mongodb cluster. I want to have only one app deployment that can manage all my tenants.

Goal

The goal of this issue is to provide some kind of a per-tenant config or config resolver.

The goal of this ticket is to make a list of all mongoose Model functions that do not have proper multi-tenancy support and add the missing implementations.

• deleteOne
• deleteMany
• countDocuments

Is there a way to force the tenantId to be required? I would like for the tenant id to never be null and I'm having trouble altering the schema after the plugin has ran. If I edit the mongo-tenant code, and add required: true it works. Is there something I'm missing?

Add a plugin option to disable injection of tenant property when calling model.byTenant(tenant).create(),
only enables it for find, count queries

Automated tests should run against the active node lts versions.

• adjust travis config to run tests against node 4, 6 & 8

I am a bit curious on why collection-level multi-tenancy is not recommended. I am particularly interested in micro-services scenario where each 'function' of the business is a separate microservice having a separate database. So, each database is not going to have a very large number of collections if collection-level multi-tenancy is applied. Would like to hear from you on this. Thanks

Beautifully designed and simple API. Great work. Awesome!

Hello there, we are experiencing some problems using aggregate with node-mongo-tenant, your implementation of the aggregate is changing the way we need to call the aggregate function. The standart Mongoose way is:

Model.aggregate([{ $match: something }])

But the way you implemented the aggregate, we need to remove the brackets:

Model.aggregate({ $match: something })

I dont't know if this is the intended behavior, but if is not, a quick fix is possible: instead of slicing the arguments, you just need to get the pipeline passed to aggregate and unshift it to add the $match on the tenantIdKey.

  static aggregate(pipeline) {
    
    if (this.hasTenantContext) {
      pipeline.unshift({
        $match: {
          [tenantIdKey]: this[tenantIdGetter]()
        }
      })
    }

    return super.aggregate.apply(this, pipeline);
  }

The incompatibility with mongoose, due to a missing new statement in mongoose.Model.create got fixed in mongoose 4.8.3. So we need to adjust the package compatibility definition.

see #5

Hello,
has anyone face issue when calling "countdocuments()" function on the schema which has tenant plugin included it returns all the records ignoring their tenatIds?

Hi, I'm am trying to implement node_mongo_tenant with node-restful for my app, but I am struggling figuring out a way to make work.
When I define the byTenant method soon after the model, and before registering the route on node-restful, I must know the Tenant(user) by the time. As the user is going to be known only after login and the route with pre-determined tenant is already registered, I can't find a way to change the tenant constant so it will apply the right tenant to the route.
I thought on registering the route after login as solution, but it would have serious implications for the app. Is there any smarter idea? As u may see, it's a newbie question. Thanks

Hey,

unforunately I'm still able to delete documents across tenants via mongoose's deleteOne function.

Could you please have a look?
Cheers 👍

The insertMany middle is currently not guarded by mongo-tenant.

• ensure all documents passed to insertMany are bound to the tenant
• write tests

Hello, I'm trying to use mongo-tenant with mongoose discriminators. But I'm having a problem in this piece of the code:

// inherit all static properties from the mongoose base model
    for (let staticProperty of Object.getOwnPropertyNames(BaseModel)) {
      if (MongoTenantModel.hasOwnProperty(staticProperty)
      || ['arguments', 'caller'].indexOf(staticProperty) !== -1
      ) {
        continue;
      }

      MongoTenantModel[staticProperty] = BaseModel[staticProperty];
    }

    return MongoTenantModel;

This throws the following error:

TypeError: Cannot assign to read only property 'baseModelName' of function 'class MongoTenantModel extends BaseModel

The problem is that the discriminator sets a property baseModelName that has the following descriptor:

{ 
  value: 'baseModelName',
  writable: false,
  enumerable: false,
  configurable: true
}

And since is not settable, it throws an error.

MongooseError: Mongoose 5.x disallows passing a spread of operators to Model.aggregate(). Instead of Model.aggregate({ $match }, { $skip }), do Model.aggregate([{ $match }, { $skip }])
at Function.aggregate (/Users/johnny/projects/work/tenant-test/node_modules/mongoose/lib/model.js:3921:11)
at Function.aggregate (/Users/johnny/projects/work/tenant-test/node_modules/mongo-tenant/index.js:295:32)
at file:///Users/johnny/projects/work/tenant-test/index.js:31:49
at Layer.handle [as handle_request] (/Users/johnny/projects/work/tenant-test/node_modules/router/lib/layer.js:102:15)
at next (/Users/johnny/projects/work/tenant-test/node_modules/router/lib/route.js:144:13)
at Route.dispatch (/Users/johnny/projects/work/tenant-test/node_modules/router/lib/route.js:109:3)
at handle (/Users/johnny/projects/work/tenant-test/node_modules/router/index.js:515:11)
at Layer.handle [as handle_request] (/Users/johnny/projects/work/tenant-test/node_modules/router/lib/layer.js:102:15)
at /Users/johnny/projects/work/tenant-test/node_modules/router/index.js:291:22
at Function.process_params (/Users/johnny/projects/work/tenant-test/node_modules/router/index.js:349:12)
at next (/Users/johnny/projects/work/tenant-test/node_modules/router/index.js:285:10)
at file:///Users/johnny/projects/work/tenant-test/index.js:22:3
at Layer.handle [as handle_request] (/Users/johnny/projects/work/tenant-test/node_modules/router/lib/layer.js:102:15)
at trim_prefix (/Users/johnny/projects/work/tenant-test/node_modules/router/index.js:330:13)
at /Users/johnny/projects/work/tenant-test/node_modules/router/index.js:294:7
at Function.process_params (/Users/johnny/projects/work/tenant-test/node_modules/router/index.js:349:12)

Write brief contribution guidelines

• follow gitflow
• keep test-coverage 100%
• ...

when i add the flag doesnt even create the index.
im using "mongoose": "^5.9.25",
best regards

In my application there are special kind of users which may have access to different tenants, that means tenantId should be an array.

Currently it's not supported, looks like the only needed change is inside installMiddleware method which intercepts mongoose queries

I would like to use the tenantIdKey value automatically when I create new objects instead of hard coding it. I am using custom tenantIdKey field specified as a config value.

Instead of:

  Cup.create({...body, 'tenantId': user.id})
    .then((cup) => cup.view(true))
    .then(success(res, 201))
    .catch(next)

I think it would be nice to just specify it in a similar manner to update, delete, query where it fills in the proper key:

  Cup.byTenantId(user.id).create(body)
    .then((cup) => cup.view(true))
    .then(success(res, 201))
    .catch(next)

And it could automatically fill in the tenantId field. Not sure if this is useful or not, maybe this is a bad idea?

In find middleware the tenant id is always casted to string.

see Automattic/mongoose#4947

Currently the tests emit a deprecation warning:

(node:1730) DeprecationWarning: Mongoose: mpromise (mongoose's default promise library) is deprecated, plug in your own promise library instead: http://mongoosejs.com/docs/promises.html

Hi,
Thanks for the useful utility.
Is there a way to push the tenantId filter down into Subdocument populate.
I tried to add _conditions in pre hook of the 'find' method but the object has no clue at this stage about its parent. Find pre hook is called for each subdocument populate construct.

this.schema.pre('find', function(next) {
//add here
});
Another approach I tried, which seems to work but looks a bit cumbersome is in mongoose/lib/model.js code. Here I can fetch the parent object's tenantId and pass it to match clause of the subdocument.

Any recommendation on the right approach to implement this.

Best regards
Pav

Hi, I've been using this plugin for a long time now but I have an interesting use-case that I'm trying to solve without actually forking this library. Basically, we already use the plugin to add a tenantId to every mongoose model in our application, but we want to take it one step further. I wanted to add another field to the same model where I could chain the accessorMethod's and continue to narrow down the search. For example:

User

{
   name: "Aaron",
   tenantId: "A",
   tenantId2: "1"
}
{
   name: "Alrik",
   tenantId: "A",
   tenantId2: "2"
}
{
   name: "Someone",
   tenantId: "B",
   tenantId2: "2"
}

Basically as it stands right now I have to use User.byTenant("A") to get the model that I need for querying. But what I'd like to be able to do is something like User.byTenant("A").byTenant2("1") which would just return the Aaron user. I know it's not a typical use-case but just wondered if there would be an easy way to implement this. Otherwise if I end up forking it, do you have any recommendations?

when a user is part of multiple tenants,
to perform a mongo operation we need it to work on all tenant ids associated to the user.

currently, as a workaround, i return multiple models and execute the operation on all of them
but it will be nice to pass an array of ids