Skip to content

Updated README #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 8, 2023
Merged

Updated README #2

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2fa5932
Fixed some mistakes and missing info in the README
nnoce14 May 8, 2023
5f4abd7
Minor fixes to the README
nnoce14 May 8, 2023
0f73cd8
Final changes
nnoce14 May 8, 2023
b00de1b
Final commit
nnoce14 May 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 69 additions & 33 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
[![npm version](https://badge.fury.io/js/apollo-datasource-mongodb.svg)](https://www.npmjs.com/package/apollo-datasource-mongodb)
<!-- [![npm version](https://badge.fury.io/js/apollo-datasource-mongodb.svg)](https://www.npmjs.com/package/apollo-datasource-mongodb) -->

MongoDB [data source](https://www.apollographql.com/docs/apollo-server/data/fetching-data) for Apollo Server 4

This is a forked repository from [apollo-datasource-mongodb](https://github.com/GraphQLGuide/apollo-datasource-mongodb) that implemented
some changes made to data sources in Apollo Server 4. The package this is forking uses Apollo Server 3 conventions. I updated the `MongoDataSource` class
in this package to be compliant with Apollo Server 4 data sources. See [dataSources](https://www.apollographql.com/docs/apollo-server/migration/#datasources) for more information.

**Installation**
```
npm i apollo-mongo-datasource
```
Expand Down Expand Up @@ -77,17 +82,19 @@ const { url } = await startStandaloneServer(server, {
})
```

Inside the data source, the collection is available at `this.collection` (e.g. `this.collection.update({_id: 'foo, { $set: { name: 'me' }}})`). The model (if you're using Mongoose) is available at `this.model` (`new this.model({ name: 'Alice' })`). In Apollo Server 3, the context was automatically handled by the abstract DataSource class from apollo-datasource. This package has been deprecated, so the DataSource class has been removed from this package, as well as the initialize method. By default, the API classes you create will not have access to the context. You can either choose to add the data that your API class needs as private members of the class, or you can add the entire context as a member of the class if you wish. All you need to do is add the field to the options argument of the constructor and call super. Then, the request's context is available at `this.context`. For example, if you put the logged-in user's ID on context as `context.currentUserId`:
Inside the data source, the collection is available at `this.collection` (e.g. `this.collection.update({_id: 'foo, { $set: { name: 'me' }}})`). The model (if you're using Mongoose) is available at `this.model` (`new this.model({ name: 'Alice' })`). In Apollo Server 3, the context was automatically handled by the abstract `DataSource` class from apollo-datasource. This package has been deprecated, so the `DataSource` class has been removed from this package, as well as the initialize method.

By default, the API classes you create will not have access to the context. You can either choose to add the data that your API class needs on a case-by-case basis as members of the class, or you can add the entire context as a member of the class if you wish. All you need to do is add the field(s) to the options argument of the constructor and call super passing in options. For example, if you put the logged-in user's ID on context as `context.currentUserId` and you want your Users class to have access to `currentUserId`:

```js
class Users extends MongoDataSource {
constructor(options) {
super(options)
this.context = options.context
this.currentUserId = options.currentUserId
}

async getPrivateUserData(userId) {
const isAuthorized = this.context.currentUserId === userId
const isAuthorized = this.currentUserId === userId
if (isAuthorized) {
const user = await this.findOneById(userId)
return user && user.privateData
Expand All @@ -96,7 +103,7 @@ class Users extends MongoDataSource {
}
```

and you would instantiate the Users class like this
and you would instantiate the Users data source in the context like this

```js
...
Expand All @@ -106,27 +113,55 @@ const server = new ApolloServer({
})

const { url } = await startStandaloneServer(server, {
context: async ({ req }) => ({
dataSources: {
users: new Users({ modelOrCollection: UserModel, context: { currentUserId: '123' } })
context: async ({ req }) => {
const currentUserId = getCurrentUserId(req) // not a real function, for demo purposes only
return {
currentUserId,
dataSources: {
users: new Users({ modelOrCollection: UserModel, currentUserId })
},
}
}),
},
});
```

If you want your data source to have access to the entire context, you need to create a Context class so the context can refer to itself as this in the constructor for the data source.
If you want your data source to have access to the entire context at `this.context`, you need to create a `Context` class so the context can refer to itself as `this` in the constructor for the data source.
See [dataSources](https://www.apollographql.com/docs/apollo-server/migration/#datasources) for more information regarding how data sources changed from Apollo Server 3 to Apollo Server 4.

```js
class Users extends MongoDataSource {
constructor(options) {
super(options)
this.context = options.context
}

async getPrivateUserData(userId) {
const isAuthorized = this.context.currentUserId === userId
if (isAuthorized) {
const user = await this.findOneById(userId)
return user && user.privateData
}
}
}

...

class Context {
constructor() {
constructor(req) {
this.currentUserId = getCurrentUserId(req), // not a real function, for demo purposes only
this.dataSources = {
users: new Users({ modelOrCollection: UserModel, context: this })
},
this.currentUserId = '123',
...
}
}

...

const { url } = await startStandaloneServer(server, {
context: async ({ req }) => {
return new Context(req)
},
});
```

If you're passing a Mongoose model rather than a collection, Mongoose will be used for data fetching. All transformations defined on that model (virtuals, plugins, etc.) will be applied to your data before caching, just like you would expect it. If you're using reference fields, you might be interested in checking out [mongoose-autopopulate](https://www.npmjs.com/package/mongoose-autopopulate).
Expand Down Expand Up @@ -229,17 +264,17 @@ interface UserDocument {
interests: [string]
}

// This is optional
interface Context {
loggedInUser: UserDocument
dataSources: any
}

export default class Users extends MongoDataSource<UserDocument, Context> {
protected loggedInUser: UserDocument;
protected loggedInUser: UserDocument

constructor(options: { loggedInUser: UserDocument } & MongoDataSourceConfig<TData>) {
super(options);
this.loggedInUser = options.loggedInUser;
super(options)
this.loggedInUser = options.loggedInUser
}

getUser(userId) {
Expand Down Expand Up @@ -267,20 +302,20 @@ const server = new ApolloServer({

const { url } = await startStandaloneServer(server, {
context: async ({ req }) => {
const loggedInUser = getLoggedInUser(req); // this function does not exist, just for demo purposes
const loggedInUser = getLoggedInUser(req) // this function does not exist, just for demo purposes
return {
loggedInUser,
dataSources: {
users: new Users({ modelOrCollection: client.db().collection('users'), loggedInUser})
users: new Users({ modelOrCollection: client.db().collection('users'), loggedInUser }),
},
};
}
},
});
```

You can also opt to pass the entire context into your data source class. You can do so by adding a protected context member
to your data source class and modifying to options argument of the constructor to add a field for the context. Then, call super and
assign the context to the member field on your data source class.
assign the context to the member field on your data source class. Note: context needs to be a class in order to do this.

```ts
import { MongoDataSource } from 'apollo-mongo-datasource'
Expand All @@ -294,17 +329,24 @@ interface UserDocument {
interests: [string]
}

// This is optional
interface Context {
class Context {
loggedInUser: UserDocument
dataSources: any

constructor(req: any) {
this.loggedInUser = getLoggedInUser(req)
this.dataSources = {
users: new Users({ modelOrCollection: client.db().collection('users'), context: this }),
}
}
}

export default class Users extends MongoDataSource<UserDocument, Context> {
protected context: Context;
protected context: Context

constructor(options: { context: Context } & MongoDataSourceConfig<TData>) {
super(options);
this.context = options.context;
super(options)
this.context = options.context
}

getUser(userId) {
Expand Down Expand Up @@ -332,13 +374,7 @@ const server = new ApolloServer({

const { url } = await startStandaloneServer(server, {
context: async ({ req }) => {
const loggedInUser = getLoggedInUser(req); // this function does not exist, just for demo purposes
return {
loggedInUser,
dataSources: {
users: new Users({ modelOrCollection: client.db().collection('users'), context: this })
},
};
return new Context(req)
},
});
```
Expand Down