Merge branch 'master' into BrunnerLivio-patch-1

kamilmysliwiec · kamilmysliwiec · commit 899e30fea9e6 · 2021-09-30T09:01:49.000+02:00
diff --git a/content/controllers.md b/content/controllers.md
@@ -407,6 +407,8 @@ async create(createCatDto) {
 }
 ```
 
+> info **Hint** Our `ValidationPipe` can filter out properties that should not be received by the method handler. In this case, we can whitelist the acceptable properties, and any property not included in the whitelist is automatically stripped from the resulting object. In the `CreateCatDto` example, our whitelist is the `name`, `age`, and `breed` properties. Learn more [here](https://docs.nestjs.com/techniques/validation#stripping-properties).
+
 #### Handling errors
 
 There's a separate chapter about handling errors (i.e., working with exceptions) [here](/exception-filters).
diff --git a/content/discover/who-uses.json b/content/discover/who-uses.json
@@ -248,6 +248,7 @@
     "https://pchas.ir",
     "https://tayeh.ir",
     "https://forwardigital.co.uk",
-    "https://rozetka.com.ua"
+    "https://rozetka.com.ua",
+    "https://www.itrio.net"
   ]
 }
diff --git a/content/faq/hybrid-application.md b/content/faq/hybrid-application.md
@@ -8,7 +8,7 @@ const microservice = app.connectMicroservice({
   transport: Transport.TCP,
 });
 
-await app.startAllMicroservicesAsync();
+await app.startAllMicroservices();
 await app.listen(3001);
 ```
 
@@ -31,7 +31,7 @@ const microserviceRedis = app.connectMicroservice<MicroserviceOptions>({
   },
 });
 
-await app.startAllMicroservicesAsync();
+await app.startAllMicroservices();
 await app.listen(3001);
 ```
 
diff --git a/content/faq/serverless.md b/content/faq/serverless.md
@@ -271,6 +271,7 @@ return {
   ...options,
   externals: [],
   output: {
+    ...options.output,
     libraryTarget: 'commonjs2',
   },
   // ... the rest of the configuration
diff --git a/content/graphql/complexity.md b/content/graphql/complexity.md
@@ -35,11 +35,12 @@ import {
 export class ComplexityPlugin implements ApolloServerPlugin {
   constructor(private gqlSchemaHost: GraphQLSchemaHost) {}
 
-  requestDidStart(): GraphQLRequestListener {
+  async requestDidStart(): Promise<GraphQLRequestListener> {
+    const maxComplexity = 20;
     const { schema } = this.gqlSchemaHost;
 
     return {
-      didResolveOperation({ request, document }) {
+      async didResolveOperation({ request, document }) {
         const complexity = getComplexity({
           schema,
           operationName: request.operationName,
@@ -50,9 +51,9 @@ export class ComplexityPlugin implements ApolloServerPlugin {
             simpleEstimator({ defaultComplexity: 1 }),
           ],
         });
-        if (complexity >= 20) {
+        if (complexity > maxComplexity) {
           throw new GraphQLError(
-            `Query is too complex: ${complexity}. Maximum allowed complexity: 20`,
+            `Query is too complex: ${complexity}. Maximum allowed complexity: ${maxComplexity}`,
           );
         }
         console.log('Query Complexity:', complexity);
diff --git a/content/graphql/directives.md b/content/graphql/directives.md
@@ -10,10 +10,10 @@ A directive is an identifier preceded by a `@` character, optionally followed by
 
 #### Custom directives
 
-To create a custom schema directive, declare a class which extends the `SchemaDirectiveVisitor` class exported from the `apollo-server` package.
+To create a custom schema directive, declare a class which extends the `SchemaDirectiveVisitor` class exported from the `@graphql-tools/utils` package.
 
 ```typescript
-import { SchemaDirectiveVisitor } from 'apollo-server';
+import { SchemaDirectiveVisitor } from '@graphql-tools/utils';
 import { defaultFieldResolver, GraphQLField } from 'graphql';
 
 export class UpperCaseDirective extends SchemaDirectiveVisitor {
@@ -32,6 +32,8 @@ export class UpperCaseDirective extends SchemaDirectiveVisitor {
 
 > info **Hint** Note that directives cannot be decorated with the `@Injectable()` decorator. Thus, they are not able to inject dependencies.
 
+> warning **Warning** `SchemaDirectiveVisitor` is exported from the `@graphql-tools/utils` package. Note that the 8.x release of `graphql-tools` removes this export and provides a different and incompatible approach to directives, so make sure to install `@graphql-tools/utils@^7` in your project.
+
 Now, register the `UpperCaseDirective` in the `GraphQLModule.forRoot()` method:
 
 ```typescript
diff --git a/content/graphql/plugins.md b/content/graphql/plugins.md
@@ -15,10 +15,10 @@ import {
 
 @Plugin()
 export class LoggingPlugin implements ApolloServerPlugin {
-  requestDidStart(): GraphQLRequestListener {
+  async requestDidStart(): Promise<GraphQLRequestListener> {
     console.log('Request started');
     return {
-      willSendResponse() {
+      async willSendResponse() {
         console.log('Will send response');
       },
     };
diff --git a/content/graphql/quick-start.md b/content/graphql/quick-start.md
@@ -202,6 +202,26 @@ definitionsFactory.generate({
 });
 ```
 
+#### Apollo Sandbox
+
+To use [Apollo Sandbox](https://www.apollographql.com/blog/announcement/platform/apollo-sandbox-an-open-graphql-ide-for-local-development/) instead of the `graphql-playground` as a GraphQL IDE for local development, use the following configuration:
+
+```typescript
+import { Module } from '@nestjs/common';
+import { GraphQLModule } from '@nestjs/graphql';
+import { ApolloServerPluginLandingPageLocalDefault } from 'apollo-server-core';
+
+@Module({
+  imports: [
+    GraphQLModule.forRoot({
+      playground: false,
+      plugins: [ApolloServerPluginLandingPageLocalDefault()],
+    }),
+  ],
+})
+export class AppModule {}
+```
+
 #### Example
 
 A fully working schema first sample is available [here](https://github.com/nestjs/nest/tree/master/sample/12-graphql-schema-first).
diff --git a/content/graphql/scalars.md b/content/graphql/scalars.md
@@ -10,7 +10,7 @@ The code-first approach ships with five scalars in which three of them are simpl
 - `Int` (alias for `GraphQLInt`) - a signed 32‐bit integer
 - `Float` (alias for `GraphQLFloat`) - a signed double-precision floating-point value
 - `GraphQLISODateTime` - a date-time string at UTC (used by default to represent `Date` type)
-- `GraphQLTimestamp` - a numeric string which represents time and date as number of milliseconds from start of UNIX epoch
+- `GraphQLTimestamp` - a signed integer which represents date and time as number of milliseconds from start of UNIX epoch
 
 The `GraphQLISODateTime` (e.g. `2019-12-03T09:54:33Z`) is used by default to represent the `Date` type. To use the `GraphQLTimestamp` instead, set the `dateScalarMode` of the `buildSchemaOptions` object to `'timestamp'` as follows:
 
diff --git a/content/microservices/mqtt.md b/content/microservices/mqtt.md
@@ -1,6 +1,6 @@
 ### MQTT
 
-[MQTT](https://mqtt.org/) (Message Queuing Telemetry Transport) is an open source, lightweight messaging protocol, optimized for high-latency. This protocol provides a scalable and cost-efficient way to connect devices using a **publish/subscribe** model. A communication system built on MQTT consists of the publishing server, a broker and one or more clients. It is designed for constrained devices and low-bandwidth, high-latency or unreliable networks.
+[MQTT](https://mqtt.org/) (Message Queuing Telemetry Transport) is an open source, lightweight messaging protocol, optimized for low latency. This protocol provides a scalable and cost-efficient way to connect devices using a **publish/subscribe** model. A communication system built on MQTT consists of the publishing server, a broker and one or more clients. It is designed for constrained devices and low-bandwidth, high-latency or unreliable networks.
 
 #### Installation
 
diff --git a/content/middlewares.md b/content/middlewares.md
@@ -237,6 +237,7 @@ consumer.apply(cors(), helmet(), logger).forRoutes(CatsController);
 If we want to bind middleware to every registered route at once, we can use the `use()` method that is supplied by the `INestApplication` instance:
 
 ```typescript
+@@filename(main)
 const app = await NestFactory.create(AppModule);
 app.use(logger);
 await app.listen(3000);
diff --git a/content/recipes/prisma.md b/content/recipes/prisma.md
@@ -266,7 +266,7 @@ export class PrismaService extends PrismaClient
 }
 ```
 
-> info **Note** The `onModuleInit` is optional — if you leave it out, Prisma will connect lazily on its first call to the database. We don't bother with `onModuleDestroy`, since Prisma has its own shutdown hooks where it will destroy the connection. For more info on `enableShutdownHooks`, please see [Issues with `enableShutdownHooks`](#issues-with-enableShutdownHooks)
+> info **Note** The `onModuleInit` is optional — if you leave it out, Prisma will connect lazily on its first call to the database. We don't bother with `onModuleDestroy`, since Prisma has its own shutdown hooks where it will destroy the connection. For more info on `enableShutdownHooks`, please see [Issues with `enableShutdownHooks`](recipes/prisma#issues-with-enableshutdownhooks)
 
 Next, you can write services that you can use to make database calls for the `User` and `Post` models from your Prisma schema.
 
@@ -295,7 +295,7 @@ export class UserService {
     take?: number;
     cursor?: Prisma.UserWhereUniqueInput;
     where?: Prisma.UserWhereInput;
-    orderBy?: Prisma.UserOrderByInput;
+    orderBy?: Prisma.UserOrderByWithRelationInput;
   }): Promise<User[]> {
     const { skip, take, cursor, where, orderBy } = params;
     return this.prisma.user.findMany({
@@ -361,7 +361,7 @@ export class PostService {
     take?: number;
     cursor?: Prisma.PostWhereUniqueInput;
     where?: Prisma.PostWhereInput;
-    orderBy?: Prisma.PostOrderByInput;
+    orderBy?: Prisma.PostOrderByWithRelationInput;
   }): Promise<Post[]> {
     const { skip, take, cursor, where, orderBy } = params;
     return this.prisma.post.findMany({
diff --git a/content/recipes/router-module.md b/content/recipes/router-module.md
@@ -4,7 +4,7 @@
 
 In an HTTP application (for example, REST API), the route path for a handler is determined by concatenating the (optional) prefix declared for the controller (inside the `@Controller` decorator),
 and any path specified in the method's decorator (e.g, `@Get('users')`). You can learn more about that in [this section](/controllers#routing). Additionally,
-you can define a [global prefix](/faq/global-prefix) for all routes registered in your application, or enable [versioning]().
+you can define a [global prefix](/faq/global-prefix) for all routes registered in your application, or enable [versioning](/techniques/versioning).
 
 Also, there are edge-cases when defining a prefix at a module-level (and so for all controllers registered inside that module) may come in handy.
 For example, imagine a REST application that exposes several different endpoints being used by a specific portion of your application called "Dashboard".
diff --git a/content/security/rate-limiting.md b/content/security/rate-limiting.md
@@ -37,6 +37,30 @@ There may be a time where you want to bind the guard to a controller or globally
 
 There is also the `@Throttle()` decorator which can be used to override the `limit` and `ttl` set in the global module, to give tighter or looser security options. This decorator can be used on a class or a function as well. The order for this decorator does matter, as the arguments are in the order of `limit, ttl`.
 
+#### Proxies
+
+If your application runs behind a proxy server, check the specific HTTP adapter options ([express](http://expressjs.com/en/guide/behind-proxies.html) and [fastify](https://www.fastify.io/docs/latest/Server/#trustproxy)) for the `trust proxy` option and enable it. Doing so will allow you to get the original IP address from the `X-Forward-For` header, and you can override the `getTracker()` method to pull the value from the header rather than from `req.ip`. The following example works with both express and fastify:
+
+```ts
+// throttler-behind-proxy.guard.ts
+import { ThrottlerGuard } from '@nestjs/throttler';
+import { Injectable } from '@nestjs/common';
+
+@Injectable()
+export class ThrottlerBehindProxyGuard extends ThrottlerGuard {
+  protected getTracker(req: Record<string, any>): string {
+    return req.ips.length ? req.ips[0] : req.ip; // individualize IP extraction to meet your own needs
+  }
+}
+
+// app.controller.ts
+import { ThrottlerBehindProxyGuard } from './throttler-behind-proxy.guard';
+
+@UseGuards(ThrottlerBehindProxyGuard)
+```
+
+> info **Hint** You can find the API of the `req` Request object for express [here](https://expressjs.com/en/api.html#req.ips) and for fastify [here](https://www.fastify.io/docs/latest/Request/).
+
 #### Websockets
 
 This module can work with websockets, but it requires some class extension. You can extend the `ThrottlerGuard` and override the `handleRequest` method like so:
diff --git a/content/techniques/streaming-files.md b/content/techniques/streaming-files.md
@@ -45,3 +45,25 @@ export class FileController {
   }
 }
 ```
+
+The default content type is `application/octet-stream`, if you need to customize the response you can use the `res.set` method.
+
+
+```ts
+import { Controller, Get, StreamableFile, Response } from '@nestjs/common';
+import { createReadStream } from 'fs';
+import { join } from 'path';
+
+@Controller('file')
+export class FileController {
+  @Get()
+  getFile(@Response({ passthrough: true }) res): StreamableFile {
+    const file = createReadStream(join(process.cwd(), 'package.json'));
+    res.set({
+      'Content-Type': 'application/json',
+      'Content-Disposition': 'attachment; filename="package.json"',
+    });
+    return new StreamableFile(file);
+  }
+}
+```

Original file line number	Diff line number	Diff line change
`@@ -407,6 +407,8 @@ async create(createCatDto) {`
`407`	`407`	`}`
`408`	`408`	```
`409`	`409`
	`410`	+> info Hint Our `ValidationPipe` can filter out properties that should not be received by the method handler. In this case, we can whitelist the acceptable properties, and any property not included in the whitelist is automatically stripped from the resulting object. In the `CreateCatDto` example, our whitelist is the `name`, `age`, and `breed` properties. Learn more [here](https://docs.nestjs.com/techniques/validation#stripping-properties).
	`411`	`+`
`410`	`412`	`#### Handling errors`
`411`	`413`
`412`	`414`	`There's a separate chapter about handling errors (i.e., working with exceptions) [here](/exception-filters).`
Original file line number	Diff line number	Diff line change
`@@ -248,6 +248,7 @@`
`248`	`248`	`"https://pchas.ir",`
`249`	`249`	`"https://tayeh.ir",`
`250`	`250`	`"https://forwardigital.co.uk",`
`251`		`- "https://rozetka.com.ua"`
	`251`	`+ "https://rozetka.com.ua",`
	`252`	`+ "https://www.itrio.net"`
`252`	`253`	`]`
`253`	`254`	`}`