feat(boot): implement Service booter

docs/site/Booting-an-Application.md

@@ -237,6 +237,33 @@ The `datasources` object support the following options:
 | `nested`     | `boolean`            | `true`               | Look in nested directories in `dirs` for DataSource artifacts                                                 |
 | `glob`       | `string`             |                      | A `glob` pattern string. This takes precendence over above 3 options (which are used to make a glob pattern). |
 
+### Service Booter
+
+#### Description
+
+Discovers and binds Service providers using `app.serviceProvider()` (Application
+must use `ServiceMixin` from `@loopback/service-proxy`).
+
+**IMPORTANT:** For a class to be recognized by `ServiceBooter` as a service
+provider, its name must end with `Provider` suffix and its prototype must have a
+`value()` method.
+
+#### Options
+
+The options for this can be passed via `BootOptions` when calling
+`app.boot(options: BootOptions)`.
+
+The options for this are passed in a `services` object on `BootOptions`.
+
+Available options on the `services` object on `BootOptions` are as follows:
+
+| Options      | Type                 | Default              | Description                                                                                                  |
+| ------------ | -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------ |
+| `dirs`       | `string \| string[]` | `['repositories']`   | Paths relative to projectRoot to look in for Service artifacts                                               |
+| `extensions` | `string \| string[]` | `['.repository.js']` | File extensions to match for Service artifacts                                                               |
+| `nested`     | `boolean`            | `true`               | Look in nested directories in `dirs` for Service artifacts                                                   |
+| `glob`       | `string`             |                      | A `glob` pattern string. This takes precedence over above 3 options (which are used to make a glob pattern). |
+
 ### Custom Booters
 
 A custom Booter can be written as a Class that implements the `Booter`

docs/site/sidebars/lb4_sidebar.yml

@@ -95,10 +95,6 @@ children:
       url: soap-calculator-tutorial-add-controller.html
       output: 'web, pdf'
 
-    - title: 'Register the Service'
-      url: soap-calculator-tutorial-register-service.html
-      output: 'web, pdf'
-
     - title: 'Run and Test it'
       url: soap-calculator-tutorial-run-and-test.html
       output: 'web, pdf'

docs/site/soap-calculator-tutorial-add-controller.md

@@ -193,4 +193,5 @@ the divide end point method.
 
 Previous step: [Add a Service](soap-calculator-tutorial-add-service.md)
 
-Next step: [Register the Service](soap-calculator-tutorial-register-service.md)
+Next step:
+[Run and Test the Application](soap-calculator-tutorial-run-and-test.md)

docs/site/soap-calculator-tutorial-run-and-test.md

@@ -66,5 +66,4 @@ options = Object.assign(
 
 ### Navigation
 
-Previous step:
-[Register the Service](soap-calculator-tutorial-register-service.md)
+Previous step: [Add a Controller](soap-calculator-tutorial-add-controller.md)

docs/site/soap-calculator-tutorial-scaffolding.md

@@ -12,12 +12,14 @@ Let's start by creating the initial application by running the following
 command:
 
 ```sh
-lb4 app soap-calculator --enableRepository
+lb4 app soap-calculator --enableRepository --enableServices
 ```
 
 **Note:** The option **--enableRepository** instructs the **CLI** to include a
-RepositoryMixin class in the application constructor which will be needed when
-we create the datasource.
+`RepositoryMixin` class in the application constructor which will be needed when
+we create the datasource. The option **--enableServices** instructs the **CLI**
+to include a `ServiceMixin` class in the application constructor which will be
+needed to register our SOAP service client.
 
 **LB4** will ask you a few questions _(you can leave the default options)_. The
 description and the root directory are obvious. The class name referes to the
@@ -31,8 +33,9 @@ application.ts file.
 ```
 
 Next you will see a list of options for the build settings, if you did not
-specify --enableRepository in the last command, then you will see it in this
-list, make sure you enable the repository for the application.
+specify `--enableRepository` and `--enableServices` in the last command, then
+you will see them in this list, make sure you enable both the repository and the
+services for the application.
 
 **Note:** Enable all options, unless you know what you are doing, see
 [The Getting Started guide](Getting-started.md) for more information.

docs/site/todo-tutorial-geocoding-service.md

@@ -94,12 +94,12 @@ docs here: [REST connector](/doc/en/lb3/REST-connector.html).
 
 Create a new directory `src/services` and add the following two new files:
 
-- `src/geocoder.service.ts` defining TypeScript interfaces for Geocoder service
-  and implementing a service proxy provider.
+- `src/services/geocoder.service.ts` defining TypeScript interfaces for Geocoder
+  service and implementing a service proxy provider.
 - `src/index.ts` providing a conventient access to all services via a single
   `import` statement.
 
-#### src/geocoder.service.ts
+#### src/services/geocoder.service.ts
 
 ```ts
 import {getService, juggler} from '@loopback/service-proxy';
@@ -140,35 +140,6 @@ export class GeocoderServiceProvider implements Provider<GeocoderService> {
 export * from './geocoder.service';
 ```
 
-### Register the service for dependency injection
-
-Because `@loopback/boot` does not support loading of services yet (see
-[issue #1439](https://github.com/strongloop/loopback-next/issues/1439)), we need
-to add few code snippets to our Application class to take care of this task.
-
-#### src/application.ts
-
-```ts
-import {ServiceMixin} from '@loopback/service-proxy';
-
-export class TodoListApplication extends BootMixin(
-  ServiceMixin(RepositoryMixin(RestApplication)),
-) {
-  constructor(options?: ApplicationConfig) {
-    super(options);
-    // etc., keep the existing code without changes
-
-    // ADD THE FOLLOWING LINE AT THE END
-    this.setupServices();
-  }
-
-  // ADD THE FOLLOWING TWO METHODS
-  setupServices() {
-    this.serviceProvider(GeocoderServiceProvider);
-  }
-}
-```
-
 ### Enhance Todo model with location data
 
 Add two new properties to our Todo model: `remindAtAddress` and `remindAtGeo`.

examples/soap-calculator/src/application.ts

@@ -4,7 +4,6 @@ import {RepositoryMixin} from '@loopback/repository';
 import {RestApplication} from '@loopback/rest';
 import {ServiceMixin} from '@loopback/service-proxy';
 import {MySequence} from './sequence';
-import {CalculatorServiceProvider} from './services/calculator.service';
 
 export class SoapCalculatorApplication extends BootMixin(
   ServiceMixin(RepositoryMixin(RestApplication)),
@@ -15,9 +14,6 @@ export class SoapCalculatorApplication extends BootMixin(
     // Set up the custom sequence
     this.sequence(MySequence);
 
-    //bind services
-    this.setupServices();
-
     this.projectRoot = __dirname;
     // Customize @loopback/boot Booter Conventions here
     this.bootOptions = {
@@ -29,8 +25,4 @@ export class SoapCalculatorApplication extends BootMixin(
       },
     };
   }
-
-  setupServices() {
-    this.serviceProvider(CalculatorServiceProvider);
-  }
 }

examples/todo/src/application.ts

@@ -9,7 +9,6 @@ import {RepositoryMixin} from '@loopback/repository';
 import {RestApplication} from '@loopback/rest';
 import {ServiceMixin} from '@loopback/service-proxy';
 import {MySequence} from './sequence';
-import {GeocoderServiceProvider} from './services';
 
 export class TodoListApplication extends BootMixin(
   ServiceMixin(RepositoryMixin(RestApplication)),
@@ -30,13 +29,5 @@ export class TodoListApplication extends BootMixin(
         nested: true,
       },
     };
-
-    // TODO(bajtos) Services should be created and registered by @loopback/boot
-    // See https://github.com/strongloop/loopback-next/issues/1439
-    this.setupServices();
-  }
-
-  setupServices() {
-    this.serviceProvider(GeocoderServiceProvider);
   }
 }

packages/boot/README.md

@@ -48,6 +48,7 @@ List of Options available on BootOptions Object.
 | `controllers`  | `ArtifactOptions` | ControllerBooter convention options |
 | `repositories` | `ArtifactOptions` | RepositoryBooter convention options |
 | `datasources`  | `ArtifactOptions` | DataSourceBooter convention options |
+| `services`     | `ArtifactOptions` | ServiceBooter convention options    |
 
 ### ArtifactOptions
 
@@ -159,6 +160,33 @@ Available options on the `datasources` object on `BootOptions` are as follows:
 | `nested`     | `boolean`            | `true`               | Look in nested directories in `dirs` for DataSource artifacts                                                |
 | `glob`       | `string`             |                      | A `glob` pattern string. This takes precedence over above 3 options (which are used to make a glob pattern). |
 
+### ServiceBooter
+
+#### Description
+
+Discovers and binds Service providers using `app.serviceProvider()` (Application
+must use `ServiceMixin` from `@loopback/service-proxy`).
+
+**IMPORTANT:** For a class to be recognized by `ServiceBooter` as a service
+provider, its name must end with `Provider` suffix and its prototype must have a
+`value()` method.
+
+#### Options
+
+The options for this can be passed via `BootOptions` when calling
+`app.boot(options: BootOptions)`.
+
+The options for this are passed in a `services` object on `BootOptions`.
+
+Available options on the `services` object on `BootOptions` are as follows:
+
+| Options      | Type                 | Default              | Description                                                                                                  |
+| ------------ | -------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------ |
+| `dirs`       | `string \| string[]` | `['repositories']`   | Paths relative to projectRoot to look in for Service artifacts                                               |
+| `extensions` | `string \| string[]` | `['.repository.js']` | File extensions to match for Service artifacts                                                               |
+| `nested`     | `boolean`            | `true`               | Look in nested directories in `dirs` for Service artifacts                                                   |
+| `glob`       | `string`             |                      | A `glob` pattern string. This takes precedence over above 3 options (which are used to make a glob pattern). |
+
 ## Contributions
 
 - [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)

packages/boot/docs.json

@@ -6,6 +6,7 @@
     "src/booters/controller.booter.ts",
     "src/booters/datasource.booter.ts",
     "src/booters/repository.booter.ts",
+    "src/booters/service.booter.ts",
     "src/booters/index.ts",
     "src/mixins/boot.mixin.ts",
     "src/mixins/index.ts",

packages/boot/package.json

@@ -30,6 +30,7 @@
     "@loopback/core": "^0.11.5",
     "@loopback/dist-util": "^0.3.6",
     "@loopback/repository": "^0.15.1",
+    "@loopback/service-proxy": "^0.7.1",
     "@types/debug": "0.0.30",
     "@types/glob": "^5.0.35",
     "debug": "^3.1.0",

packages/boot/src/boot.component.ts

@@ -6,7 +6,12 @@
 import {Bootstrapper} from './bootstrapper';
 import {Component, Application, CoreBindings} from '@loopback/core';
 import {inject, BindingScope} from '@loopback/context';
-import {ControllerBooter, RepositoryBooter, DataSourceBooter} from './booters';
+import {
+  ControllerBooter,
+  RepositoryBooter,
+  DataSourceBooter,
+  ServiceBooter,
+} from './booters';
 import {BootBindings} from './keys';
 
 /**
@@ -17,7 +22,12 @@ import {BootBindings} from './keys';
 export class BootComponent implements Component {
   // Export a list of default booters in the component so they get bound
   // automatically when this component is mounted.
-  booters = [ControllerBooter, RepositoryBooter, DataSourceBooter];
+  booters = [
+    ControllerBooter,
+    RepositoryBooter,
+    ServiceBooter,
+    DataSourceBooter,
+  ];
 
   /**
    *