https://github.com/skauffmann/apollo-mongoose-plugin

Apollo GraphQL plugin to add MongoDB query information on the extensions node
https://github.com/skauffmann/apollo-mongoose-plugin

apollo apollo-plugin hacktoberfest mongodb mongoose mongoose-plugin performance

Last synced: about 1 month ago
JSON representation

Apollo GraphQL plugin to add MongoDB query information on the extensions node

• Host: GitHub
• URL: https://github.com/skauffmann/apollo-mongoose-plugin
• Owner: skauffmann
• License: mit
• Created: 2021-04-28T09:39:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-01T15:18:23.000Z (about 3 years ago)
• Last Synced: 2024-09-28T20:42:13.075Z (about 2 months ago)
• Topics: apollo, apollo-plugin, hacktoberfest, mongodb, mongoose, mongoose-plugin, performance
• Language: TypeScript
• Homepage:
• Size: 228 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Apollo Mongoose Plugin

![npm version](https://badgen.net/npm/v/apollo-mongoose-plugin)

![types](https://badgen.net/npm/types/apollo-mongoose-plugin)

![license](https://badgen.net/npm/license/apollo-mongoose-plugin)

![bundlephobia](https://badgen.net/bundlephobia/min/apollo-mongoose-plugin)

[Apollo GraphQL plugin](https://www.apollographql.com/docs/apollo-server/integrations/plugins/) to add Mongodb query information on the `extensions` node.

You will have access to the queries executed by Mongoose and execution times directly from the GraphQL response as bellow:

![Apollo Mongoose Plugin](doc/apollo-mongoose-plugin.png)

## Installation

If you’re using npm:

```bash

npm install apollo-mongoose-plugin

```

With yarn:

```bash

yarn add apollo-mongoose-plugin

```

## Usage

Adding the `apollo-mongoose-plugin` plugin to your project is done in 2 steps:

1. **register the mongoose query collector plugin:** _it will add hooks to collect and measure execution times of your queries._

2. **register the apollo plugin:** _it will use the previous query collector to return queries on the GraphQL response._

```typescript

import {

  ApolloMongoosePlugin,

  mongoCollectorPlugin,

} from 'apollo-mongoose-plugin';

import { ApolloServer } from 'apollo-server';

import mongoose from 'mongoose';

// first: register mongoose query collector plugin

// 🔔  Make sure you are registering the mongoose plugin

//     before you are creating mongoose models

mongoose.plugin(mongoCollectorPlugin);

// then: register apollo plugin

const server = new ApolloServer({

  // ...schema, dataSources

  plugins: [new ApolloMongoosePlugin()],

});

```

🚨   Be aware that it is best not to activate this plugin in production. For example, you can do this:

```typescript

if (process.env.NODE_ENV !== 'production')

  mongoose.plugin(mongoCollectorPlugin);

const server = new ApolloServer({

  // ...schema, dataSources

  plugins: [

    process.env.NODE_ENV !== 'production' && new ApolloMongoosePlugin(),

  ].filter(Boolean),

});

```

## API

### `ApolloMongoosePlugin`

This is the core plugin, that you register with Apollo Server.

#### Options

| Name               | Default                              | Description                                                                                                           |

| ------------------ | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------- |

| `formatMongoQuery` | `formatMongoQueryAsString`           | Function called to format queries in the GraphQL response. You can create your own by implementing `FormatMongoQuery` |

| `mongoCollector`   | `MongooQueryCollector.getInstance()` | Instance of mongoose query collector                                                                                  |

## Contributing

You want to help? That’s awesome!

Check out the details of our [contribution process](./CONTRIBUTING.md) (it’s fairly standard).

## License and copyright

This library is © [Samuel Kauffmann](http://github.com/skauffmann) and is MIT licensed. See [LICENSE.md](./LICENSE.md) for details.