Feature/#46 mongoose model definitions

[maxiejbe]

Changes to include mongoose model as spec definitions (Issue #45):

• Init argument: mongooseModels?: Array<string>
• Dependency mongoose-to-swagger to convert mongoose models to definitions (spec).
• Dev dependencies: mongoose + bson.
• README.md + Tests.

[kiprasmel]

I think you could require the mongoose package at the top-level scope, just like you've done with m2s. This will be more efficient since you won't have to re-require the mongoose package every time the function is called (it will instead only be required once - when the file loads).

[maxiejbe]

This is a good one 😄 It was intentional. We could include the mongoose package as a:

a) Peer dependency.
This was the original idea. The installation is optional for the client (could be using Sequelize for example).
As we can't handle errors at top-level scope, it would throw in case we require an uninstalled package.
Even though it's less performant to re-require inside the generateMongooseModelsSpec scope, that function is intended to be called once and then use the same generated spec every time.

Ignore that it's also included as a Dev dependency, that was for basic_server.js testing purposes.

b) Regular dependency.
The installation would be required (even if not needed by the client).
It could also lead to issues if the mongoose package version from the client is different from the one used as a dependency on express-oas-generator.
In this case, top-level scope require would be correct.

For both cases, we should decide which is the minimum required version: https://mongoosejs.com/docs/compatibility.html

[mpashkovskiy]

Shouldn't const m2s = require('mongoose-to-swagger'); be moved inside generateMongooseModelsSpec as well to have it as peer dependency?

[maxiejbe]

Shouldn't const m2s = require('mongoose-to-swagger'); be moved inside generateMongooseModelsSpec as well to have it as peer dependency?

Sure, so should be go in both cases (mongoose, mongoose-to-swagger) with peer dependencies?

[maxiejbe]

They are all now peer dependencies (bson, mongoose, mongoose-to-swagger). We should now agree the minimum required versions.

[kiprasmel]

Could you also include this functionality in the handleResponses function? The init one is only for backwards-compatibility and basic usage only; everything else uses handleResponses and handleRequests.

[maxiejbe]

Done! I've also updated both server_basic.js and server_advanced.js examples.

[kiprasmel]

Thank you for your contribution! I haven't tried it our yet, but it looks promising:)

[mpashkovskiy]

Shouldn't const m2s = require('mongoose-to-swagger'); be moved inside generateMongooseModelsSpec as well to have it as peer dependency?

[mpashkovskiy]

using expect().to.throw(Error) makes code more readable

[maxiejbe]

Done, now using expect().toThrowError(new RegExp())

[mpashkovskiy]

Looks like here any thrown exception is overwritten and rethrown, why is it needed? Would it be better to delete try/catch and allow original error to be thrown to simplify debugging?

[maxiejbe]

Yeah, I was wrapping with an extended error message before. Just removed it.

[mpashkovskiy]

Is there any place where value returned from that functino is used? Maybe that return is not needed?

[maxiejbe]

Nope, it wasn't used. Returning void right now.

[mpashkovskiy]

@maxiejbe thanks for your contribution! I'll test it locally and publish a new version soon. Will add a comment here after.

[mpashkovskiy]

version 1.0.25 is published, @maxiejbe could you please try it and confirm that it works as expected?

[maxiejbe]

Just tried an example project and working as expected!

If mongooseModels argument is not supplied, working as previous versions.

Sending the argument to handleResponses:

expressOasGenerator.handleResponses(server, {
    predefinedSpec(spec) {
      return spec;
    },
    specOutputPath: swaggerDocumentPath,
    mongooseModels: mongoose.modelNames(),
});

First asking for the dependencies:
Error: Cannot find module 'mongoose-to-swagger'.

Then generating the model docs:

[maxiejbe]

A few comments only (but not related, it's up to mongoose-to-swagger package):

• Not removing non-public mongoose schema fields
• Not detecting Schema.Types.ObjectId (ref to another model).

[mpashkovskiy]

First asking for the dependencies:
Error: Cannot find module 'mongoose-to-swagger'.

Should it be added to README.md? Something like If you are using mongooseModels parameter don't forget install mongoose-to-swagger module?

[maxiejbe]

First asking for the dependencies:
Error: Cannot find module 'mongoose-to-swagger'.

Should it be added to README.md? Something like If you are using mongooseModels parameter don't forget install mongoose-to-swagger module?

Already done:
['User','Student'] - Mongoose models to be included as definitions. To get all just do mongoose.modelNames(). The following peer dependencies are required to use this last argument: mongoose, mongoose-to-swagger, bson.