1

Is there a best practice for a callback after a blueprint route in SailsJS 11.x?

I have an API where Users can submit Ideas. After the Idea is created, if it's the User's first Idea they should get a Badge. As far as I can tell there are two places to put this functionality.

  1. Copy/Override the Sails rest blueprint, add the functionality to the Idea.create() callback function.
  2. Add a lifecycle callback for the afterCreate action on the Idea model.

I'm assuming any functionality I write in terms of granting badges should be put in a Service so it can be shared among the different models. It seems like option 1 wouldn't be as tightly coupled, but would lead to fatter controllers.

Roy
  • 1,468
  • 4
  • 21
  • 40
  • I would go with the first option as it's more flexible. I don't mind the controllers getting a bit fat ;). – MjZac Aug 12 '15 at 22:53

2 Answers2

2

Overriding the "create" blueprint will mean that every model will use that code when handling a request to their POST /<modelName> route, which is probably not what you want. The lifecycle callback will work fine for granting the badge, but if you're looking to modify the response based on whether or not a badge was granted, this approach won't work--but you could easily send a socket notification from the lifecycle callback, using User.message().

The third option is just to override the create action in IdeaController.js. There's not all that much to it, especially if you let Waterline handle most of the field validation for you. In essence, it's just:

create: function(req, res) {
  Idea.create(req.params.all()).exec(function(err, idea) {
     if (err) {return res.negotiate(err);}
     // ... do some stuff with the idea and send a response ...
  });
}
sgress454
  • 24,870
  • 4
  • 74
  • 92
  • Sounds like a combination of 1 & 3 is what I'm looking for. I can use the blueprint Create action as a basis to extend functionality while keeping all of the sails goodies. – Roy Aug 13 '15 at 11:18
1

I would go for the second option, however you should note that afterCreate gets triggered when testing via barrels and adding items, which might be an issue for the logic in afterCreate. (Ex: A user has 3 ideas, 1 badge from the first idea, you add them to barrels fixtures. When barrels is adding the first idea it will trigger the afterCreate then it will add the badge from the fixture resulting in the user having 2 duplicate badges.)

Dinana
  • 300
  • 3
  • 14