Spike: booter for creating REST APIs from model files #3617

bajtos · 2019-08-29T13:44:27Z

Quoting from #2036:

In LoopBack 3, it was very easy to get a fully-featured CRUD REST API with
very little code: a model definition describing model properties + a model
configuration specifying which datasource to use.

Let's provide the same simplicity to LB4 users too.

User creates a model class and uses decorators to define model properties.
(No change here.)

User declaratively defines what kind of data-access patterns to provide
(CRUD, KeyValue, etc.) and what datasource to use under the hood.

@loopback/boot processes this configuration and registers appropriate
repositories & controllers with the app.

In this Spike, I am demonstrating a PoC implementation of an extensible booter
that processed model configuration files in JSON formats and uses 3rd-party
plugins to build repository & controller classes at runtime.

See SPIKE.md for further details.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

npm test passes on your machine
New tests added or existing tests modified to cover all changes
Code conforms with the style guide
API Documentation in code was updated
Documentation in /docs/site was updated
Affected artifact templates in packages/cli were updated
Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

packages/context/src/binding-decorator.ts

packages/context/src/inject.ts

packages/context/src/binding-inspector.ts

bajtos · 2019-08-29T14:01:14Z

examples/todo/src/__tests__/acceptance/todo.acceptance.ts

    // Start Application
    await app.start();
  }

  async function givenTodoRepository() {
-    todoRepo = await app.getRepository(TodoRepository);
+    todoRepo = await app.get<TodoRepository>('repositories.TodoRepository');


We don't have a repository class we could use here, TodoRepository is just a type alias for EntityCrudRepository<Todo, number>.

bajtos · 2019-08-29T14:02:14Z

examples/todo/src/__tests__/unit/controllers/todo.controller.unit.ts

-import {GeocoderService} from '../../../services';
-import {aLocation, givenTodo} from '../../helpers';
-
-describe('TodoController', () => {


I see little value in writing unit tests for controllers contributed by 3rd-party packages. The controller code should have been already tested in that package (@loopback/rest-crud in this case).

bajtos · 2019-08-29T14:02:47Z

examples/todo/src/controllers/todo.controller.ts

-import {TodoRepository} from '../repositories';
-import {GeocoderService} from '../services';
-
-export class TodoController {


No controller files, yay 🎉

bajtos · 2019-08-29T14:03:05Z

examples/todo/src/repositories/todo.repository.ts

-import {DefaultCrudRepository, juggler} from '@loopback/repository';
-import {Todo, TodoRelations} from '../models';
-
-export class TodoRepository extends DefaultCrudRepository<


No repository files, yay 🎉

bajtos · 2019-08-29T14:06:15Z

examples/todo/src/models/todo.model.ts

-    type: 'string',
-  })
-  remindAtGeo?: string; // latitude,longitude
-


In order to implement geocoder integration while using public-models/product.config.json, we need to customize the controller method defined by @loopback/rest-crud. That's kind of against the spirit of this change, where we want to use the default REST API as provided by LB. At least for the initial release, I'd like us to recommend users to switch from @loopback/rest-crud to lb4 repository & lb4 controller if they need any tweaks in the built-in functionality.

packages/booter-rest/package.json

bajtos · 2019-08-30T11:38:40Z

The spike is done and ready for review.

packages/context/src/binding-decorator.ts

packages/context/src/inject.ts

packages/metadata/src/decorator-factory.ts

_SPIKE_.md

jannyHou

👍 👍 Great effort. I left a few comments regarding the flexibility to modify the apis defined in controller class.

The todo example looks simple enough to config 👍

_SPIKE_.md

bajtos · 2019-09-06T14:29:45Z

I have updated the spike as follows:

Rebased on top of the latest master
Reworked the implementation to load model configs from JS files in dist/public-models/*.config.js instead of public-models/*.config.json
Moved RestBooter to @loopback/boot and renamed it to ModelApiBooter
Improved SPIKE docs based on review comments, updated list of implementation stories

I consider this spike as done and ready for final review & approval.

@strongloop/loopback-next PTAL.

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos · 2019-09-10T10:23:14Z

Thank you all for feedback. I decided to address it the following way:

I have renamed public-models to model-endpoints as suggested in the comments.
I am using the naming convention {model-name}.rest-config.ts, this will allow us to introduce e.g. {model-name}.grpc-config.ts in the future.
The ModelApiConfig object is referencing the model class directly now, setting model field to an imported class constructor.
I have removed app.model() API that's no longer needed.
I have update the SPIKE document accordingly.

Let's do a final round of reviews and then call the spike done.

Signed-off-by: Miroslav Bajtoš <[email protected]>

hacksparrow · 2019-09-12T09:24:29Z

I am not sure if CrudRestApiConfig is the best name (it does not mention "model"), suggestions are welcome.

Since we are focused on REST for now CrudRestApiConfig sound OK to me. And it resides under @loopback/crud-rest.

If we support more flavors, they'll have their own names and reside in their own package, if not in a generic one where CrudRestApiConfig may also reside.

hacksparrow · 2019-09-12T09:27:58Z

Oh, just realized your other point. I think it is important to give the context to CrudRestApiConfig like mode-endpoints. So maybe ModelCrudRestApiConfig?

Simply CrudRestApiConfig sounds like the LoopBack default, which it's not.

bajtos · 2019-09-12T15:41:32Z

Oh, just realized your other point. I think it is important to give the context to CrudRestApiConfig like mode-endpoints. So maybe ModelCrudRestApiConfig?

Simply CrudRestApiConfig sounds like the LoopBack default, which it's not.

Exactly!

I'll update the interface to ModelCrudRestApiConfig then. (It's an awfully long name though 🙈 )

bajtos · 2019-09-12T15:42:43Z

It's ok if we don't get the names exactly right in the spike, we can tweak them later during code review of the real implementation.

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos · 2019-09-13T14:15:36Z

Follow-up stories:

Implement TestSandbox.writeTextFile Implement TestSandbox.writeTextFile #3731
Improve defineCrudRestController to create a named controller class Improve defineCrudRestController to create a named controller class #3732
Add defineCrudRepositoryClass - a helper to create a named repository class Add defineCrudRepositoryClass - a helper to create a named repository class #3733
Model API booter & builder Model API booter & builder #3736
Add CrudRestApiBuilder to @loopback/rest-crud Add CrudRestApiBuilder to @loopback/rest-crud #3737
Example app showing CrudRestApiBuilder Example app showing CrudRestApiBuilder #3738

I am closing the spike as done.

bajtos added spike Boot REST Issues related to @loopback/rest package and REST transport in general labels Aug 29, 2019

bajtos requested a review from raymondfeng August 29, 2019 13:44

bajtos self-assigned this Aug 29, 2019

bajtos commented Aug 29, 2019

View reviewed changes

bajtos mentioned this pull request Aug 29, 2019

Spike: Booter for creating REST APIs from model files #2738

Closed

3 tasks

bajtos commented Aug 29, 2019

View reviewed changes

packages/booter-rest/package.json Outdated Show resolved Hide resolved

bajtos force-pushed the spike/crud-rest-booter branch 2 times, most recently from 12103a0 to e116ab5 Compare August 30, 2019 11:36

bajtos requested review from a team August 30, 2019 11:38

raymondfeng reviewed Aug 30, 2019

View reviewed changes

packages/context/src/binding-decorator.ts Outdated Show resolved Hide resolved

packages/context/src/inject.ts Outdated Show resolved Hide resolved

raymondfeng mentioned this pull request Aug 30, 2019

feat: allow custom decorator name for error messages #3625

Merged

7 tasks

raymondfeng reviewed Aug 30, 2019

View reviewed changes

packages/metadata/src/decorator-factory.ts Outdated Show resolved Hide resolved

This was referenced Sep 2, 2019

feat(rest-crud): add "replaceById" endpoint #3633

Merged

fix(context): allow inject to be explicitly invoked for class ctor args #3634

Merged

feat(testlab): add TestLab.writeJsonFile #3635

Merged

bajtos commented Sep 2, 2019

View reviewed changes

_SPIKE_.md Outdated Show resolved Hide resolved

jannyHou reviewed Sep 5, 2019

View reviewed changes

_SPIKE_.md Show resolved Hide resolved

_SPIKE_.md Show resolved Hide resolved

_SPIKE_.md Show resolved Hide resolved

raymondfeng reviewed Sep 5, 2019

View reviewed changes

_SPIKE_.md Show resolved Hide resolved

bajtos mentioned this pull request Sep 6, 2019

feat(context): add more logs to simplify troubleshooting #3676

Merged

3 tasks

bajtos force-pushed the spike/crud-rest-booter branch 2 times, most recently from b7c6feb to 67d1128 Compare September 6, 2019 14:27

bajtos requested review from a team, raymondfeng and jannyHou September 6, 2019 14:36

bajtos added 7 commits September 10, 2019 10:24

refactor: move RestBooter to @loopback/boot as ModelApiBooter

83cf75b

Signed-off-by: Miroslav Bajtoš <[email protected]>

docs: more explanation for extensibility

a970f0c

Signed-off-by: Miroslav Bajtoš <[email protected]>

fix: copyright headers

03b71f0

Signed-off-by: Miroslav Bajtoš <[email protected]>

docs: finalize the spike

785d4bd

Signed-off-by: Miroslav Bajtoš <[email protected]>

fixup! address review comments (refactor-rename)

2602fcc

Signed-off-by: Miroslav Bajtoš <[email protected]>

refactor: move basePath to rest-crud config iface

e10bd5e

Signed-off-by: Miroslav Bajtoš <[email protected]>

chore: cleanup

446d5f5

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos force-pushed the spike/crud-rest-booter branch from 4f74b98 to 446d5f5 Compare September 10, 2019 09:02

refactor: import models directly, change file/dir naming scheme

5f3fe52

Signed-off-by: Miroslav Bajtoš <[email protected]>

refactor: revert unnecessary changes

2969b5a

Signed-off-by: Miroslav Bajtoš <[email protected]>

raymondfeng approved these changes Sep 12, 2019

View reviewed changes

feat: rename CrudRestApiConfig to ModelCrudRestApiConfig

2848a1b

Signed-off-by: Miroslav Bajtoš <[email protected]>

hacksparrow approved these changes Sep 13, 2019

View reviewed changes

bajtos mentioned this pull request Sep 13, 2019

Implement TestSandbox.writeTextFile #3731

Closed

3 tasks

docs: add links to follow-up tasks

d8fe473

Signed-off-by: Miroslav Bajtoš <[email protected]>

bajtos closed this Sep 13, 2019

bajtos mentioned this pull request Oct 10, 2019

[SPIKE] HasMany relation definition to REST API with auto-generated repository/controller classes #3896

Closed

3 tasks

bajtos mentioned this pull request Nov 29, 2019

[Spike] Allow extensions to contribute custom booters #1461

Closed

bajtos mentioned this pull request Feb 17, 2020

feat(rest): add OAS Enhancer service #4554

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Spike: booter for creating REST APIs from model files #3617

Spike: booter for creating REST APIs from model files #3617

bajtos commented Aug 29, 2019 •

edited

Loading

bajtos Aug 29, 2019 •

edited

Loading

bajtos Aug 29, 2019

bajtos Aug 29, 2019

bajtos Aug 29, 2019

bajtos Aug 29, 2019

bajtos commented Aug 30, 2019

jannyHou left a comment

bajtos commented Sep 6, 2019

bajtos commented Sep 10, 2019 •

edited

Loading

hacksparrow commented Sep 12, 2019

hacksparrow commented Sep 12, 2019

bajtos commented Sep 12, 2019

bajtos commented Sep 12, 2019

bajtos commented Sep 13, 2019

Spike: booter for creating REST APIs from model files #3617

Spike: booter for creating REST APIs from model files #3617

Conversation

bajtos commented Aug 29, 2019 • edited Loading

Checklist

bajtos Aug 29, 2019 • edited Loading

Choose a reason for hiding this comment

bajtos Aug 29, 2019

Choose a reason for hiding this comment

bajtos Aug 29, 2019

Choose a reason for hiding this comment

bajtos Aug 29, 2019

Choose a reason for hiding this comment

bajtos Aug 29, 2019

Choose a reason for hiding this comment

bajtos commented Aug 30, 2019

jannyHou left a comment

Choose a reason for hiding this comment

bajtos commented Sep 6, 2019

bajtos commented Sep 10, 2019 • edited Loading

hacksparrow commented Sep 12, 2019

hacksparrow commented Sep 12, 2019

bajtos commented Sep 12, 2019

bajtos commented Sep 12, 2019

bajtos commented Sep 13, 2019

bajtos commented Aug 29, 2019 •

edited

Loading

bajtos Aug 29, 2019 •

edited

Loading

bajtos commented Sep 10, 2019 •

edited

Loading