fix: logger component is always required (stoplightio#713)

XVincentX · web-flow · commit 3b0b14082e4a · 2019-10-15T15:29:13.000+02:00
* fix: components are always required

* refactor: minor code style fix

* docs: update

* docs: fix
diff --git a/packages/http-server/README.md b/packages/http-server/README.md
@@ -7,9 +7,10 @@ Usage:
 ```js
 import { createServer } from '@stoplight/prism-http-server';
 
+const operations = await getHttpOperationsFromResource('./api.oas2.json');
 const server = createServer({
-  path: './api.oas2.json',
-  {}
+  operations,
+  { logger: createLoggerInstance() }
 });
 
 server.listen(3000).then(() => {
diff --git a/packages/http-server/src/__tests__/server.oas.spec.ts b/packages/http-server/src/__tests__/server.oas.spec.ts
@@ -17,12 +17,11 @@ function checkErrorPayloadShape(payload: string) {
 
 async function instantiatePrism(specPath: string) {
   const operations = await getHttpOperationsFromResource(specPath);
-  const server = createServer(operations, {
+  return createServer(operations, {
     components: { logger },
     config: { checkSecurity: true, validateRequest: true, validateResponse: true, mock: { dynamic: false } },
     cors: true,
   });
-  return server;
 }
 
 describe('GET /pet?__server', () => {
diff --git a/packages/http-server/src/server.ts b/packages/http-server/src/server.ts
@@ -14,7 +14,7 @@ export const createServer = (operations: IHttpOperation[], opts: IPrismHttpServe
   const { components, config } = opts;
 
   const server = fastify({
-    logger: (components && components.logger) || createLogger('HTTP SERVER'),
+    logger: components.logger,
     disableRequestLogging: true,
     modifyCoreObjects: false,
   });
diff --git a/packages/http-server/src/types.ts b/packages/http-server/src/types.ts
@@ -2,7 +2,7 @@ import { IHttpConfig, PickRequired, PrismHttpComponents, PrismHttpInstance } fro
 import { FastifyInstance } from 'fastify';
 
 export interface IPrismHttpServerOpts {
-  components?: PickRequired<Partial<PrismHttpComponents>, 'logger'>;
+  components: PickRequired<Partial<PrismHttpComponents>, 'logger'>;
   config: IHttpConfig;
   cors: boolean;
 }
diff --git a/packages/http/src/index.ts b/packages/http/src/index.ts
@@ -14,7 +14,7 @@ import { IHttpConfig, IHttpRequest, IHttpResponse, PickRequired, PrismHttpCompon
 
 export const createInstance = (
   defaultConfig: IHttpConfig,
-  components?: PickRequired<Partial<PrismHttpComponents>, 'logger'>,
+  components: PickRequired<Partial<PrismHttpComponents>, 'logger'>
 ) =>
   factory<IHttpOperation, IHttpRequest, IHttpResponse, IHttpConfig>(
     defaultConfig,

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@ import { IHttpConfig, PickRequired, PrismHttpComponents, PrismHttpInstance } fro`
`2`	`2`	`import { FastifyInstance } from 'fastify';`
`3`	`3`
`4`	`4`	`export interface IPrismHttpServerOpts {`
`5`		`- components?: PickRequired<Partial<PrismHttpComponents>, 'logger'>;`
	`5`	`+ components: PickRequired<Partial<PrismHttpComponents>, 'logger'>;`
`6`	`6`	`config: IHttpConfig;`
`7`	`7`	`cors: boolean;`
`8`	`8`	`}`