Mongoose Plugin for Godspeed

It provides seamless integration with MongoDB through the Mongoose library. MongoDB is a popular NoSQL database, and with this plugin, you can harness the power of Mongoose to model your data, perform queries, and interact with MongoDB in a structured and efficient manner.

How to Add

Create a godspeed project from the CLI, open the created project in vscode and then add the plugin:

godspeed plugin add @godspeedsystems/plugins-mongoose-as-datasource 

- You will find two files in your project related to the mongoose plugin at src/datasources/types/mongoose.ts and src/datasources/mongoose.yaml

src/datasources/types/mongoose.ts

import { DataSource } from '@godspeedsystems/plugins-mongoose-as-datastore';
export default DataSource;

src/datasources/mongoose.yaml

type: mongoose
successResponseCodes: #default response codes for success responses
  create: 201
  find: 200
  findOne: 200
  aggregate: 200
  findOneAndUpdate: 201
  findOneAndDelete: 202

• You can keep the file by any name. This file is used to initialize a mongoose datasource instance. Whatever is the name of the file, you will need to invoke the mongoose datasource commands by the same name. Also your models will be needed to be kept in a folder with the same name as your yaml file (i.e. your datasource instance name). For example mongoose1.yaml would mean calling fn:datasources.mongoose1.<Model_Name>.<Function_Name> from yaml workflows and ctx.datasources.mongoose1.<Model_Name>.<Function_Name> from TS/JS files. Also you will need to create a folder datasources/mongoose1/models and keep your models there as detailed below.

• You can override the default response codes for success cases for different methods by putting them in the datasource instance's yaml file

Setting up Mongoose models

This datasource loads the Mongoose models from datasources/<datasource_name>/models folder.

These files are stored in datasources/<datasource_name>/models folder.

Export Syntax :

Your TS or JS file should export as following:

datasources/<datasource_name>/models/SomeModel.ts

module.exports = {
    type: 'SomeModel', //The name by which you will access methods of this collection/model
    model: SomeModel   //The Mongoose Model
};

An example Mongoose model file

datasources/<datasource_name>/models/SomeModel.ts

const { model, Schema, Document } =require('mongoose');

const SomeModelSchema = new Schema(
  {
    partnerName: {
      type: String,
      required: true,
    },
    productType: {
      type: String,
      required: true,
    },
    apiType: {
      type: String,
      required: true,
    },
    method: {
      type: String,
    },
    api: {
      type: String,
    },
    code: String,
    headers: Schema.Types.Mixed,
    payload: Schema.Types.Mixed,
    response: Schema.Types.Mixed,
    isDynamicUrl: Boolean,
    expectedResponseStatusCode: Number,
  },
  { timestamps: true }
);

const SomeModel = model('some-model', SomeModelSchema, 'some-model');
module.exports = {
    type: 'SomeModel', //The name by which you will access methods of this collection/model
    model: SomeModel
};

Sample workflow

When calling any api function it will be called as ctx.datasources.mongoose1.<Model_Name>.<Function_Name> from TS/JS files.

events/createModel.yaml

http.post./some-models:
  fn: createUser1
  body:
    content:
      application/json:
        schema:
          type: object
          properties:
            partnerName:
              type: string
              description: Partner Name
            productType:
              type: string
              description: Product Type
            apiType:
              type: string
              description: API Type
  responses:
    201:
      description: SomeModel created successfully
      content:
        application/json:
          schema:
            type: object
            properties:
              someModel:
                type: object
                description: The created SomeModel object

import { GSContext, GSDataSource, GSStatus } from "@godspeedsystems/core";

export default async function (ctx: GSContext) {

  const mongoClient: GSDataSource = ctx.datasources.mongoose;
  const body =ctx.inputs.data.body ;
  const data = { 
    meta: {
      entityType: 'SomeModel', 
      method: 'create'
    },
    ...body
  };
  
  const response = await mongoClient.execute(ctx, data);
  return response;
}

Error response

When a call has an error the datasource returns following GSStatus.

    code: 500
    success: false
    data: 
        message: Internal Server Error

Run the service

• Set an environment variable MONGO_URL as your connection string to running mongodb instance. For example, setting via a unix shell.

    export MONGO_URL='mongodb+srv://<user_name>:<password>@cluster0.xyzabc.mongodb.net/?retryWrites=true&w=majority'

• From your command line run your service in the auto-watch mode

  godspeed serve

Reference links

- Plugin Repository
- Issue Tracker
- npm package