add service template

[hthetiot]

Todo

• [x] Dockerfile
• [x] Docker build, compose, deploy via npm
• [x] add sample joey|express http transport router to service
• [x] add sample socket.io http transport router to service
• [x] add sample UI with MainService and child HelloWorldService
• [x] dispatch serialized query (save|delete|fetch)Data to middleware.js MainService
• [x] add sample swagger
• [x] add sample test and integration
• [x] return main service result
• [x] add join|leave sample socket.io aka subscribe data
• [x] main.mjson entry point to configure service
• [x] fix nodeJS property descriptor
• [ ] add sample CLI enpoint

Overview

index.js (express.js or joey.js)

Init transport and setup middleware

• https://github.com/montagejs/minit/blob/features/serviceTemplate/templates/service/__name__/joey.js
• https://github.com/montagejs/minit/blob/features/serviceTemplate/templates/service/__name__/express.js

middleware.js

Interface transport and main-service query dispatch

• https://github.com/montagejs/minit/blob/features/serviceTemplate/templates/service/__name__/middleware.js

logic/service/name-service.js

Resolve query and return raw data for response

• https://github.com/montagejs/minit/blob/features/serviceTemplate/templates/service/__name__/logic/service/__name__-service.js

Quick Testing

minit-service.sh

export MY_SERVICE=email
rm -fr minit-service
rm -fr $MY_SERVICE
git clone -b features/serviceTemplate git@github.com:montagejs/minit.git minit-service
cd minit-service
npm i
cd ..
minit-service/minit create:service --name $MY_SERVICE
cd $MY_SERVICE
npm run test
npm run integration&
npm run doc&

Testing

git clone -b features/serviceTemplate git@github.com:montagejs/minit.git
cd minit-service
npm i
cd ..
minit-service/minit create:service --name Message
cd message
npm i
npm run start 
# Open console to see CRUD basic spec (will come CRUD basic ui later )

# Separate terminals
npm run test
npm run integration
npm run doc

Client

• http://localhost:8080
• http://localhost:8080/test
• http://localhost:8080/test/socket.html
• http://localhost:8080/doc

Server

• http://localhost:8080/api/message

Preview

[hthetiot]

Know issue with missing id|subject|text property from server. Will try to fix main.mjson using montage twitter previous technic, i wanted to finish other scaffolding first.

See:

• https://github.com/montagejs/minit/blob/features/serviceTemplate/templates/service/__name__/middleware.js#L34

Expected server result

{
  "kafka": {
    "prototype": "logic/model/kafka-model[Kafka]",
    "values": {
      "id": 42,
      "subject": "You've got mail",
      "text": "Hello World!",
      "identifier": null
    }
  },
  "root": {
    "value": [
      {"@": "kafka"}
    ]
  }
}

[tejaede]

Per conversation with @hthetiot create:service should work like create:component when called from inside an application, meaning the logic should be something like the following

Consider the following command minit create:service -n foo-service

• If current working directory is not an application

  1. Create application
  2. Add middleware.js, express.js, data/main.mjson to application
  3. Add logic/service/foo-service.js, logic/model/foo.js, data/descriptors/foo.mjson, data/foo-service.mjson to application
  4. Add reference to foo-service.mjson in main.mjson (if not added in step 1)

• If current working directory is an application, but does not have stack

  1. Add middleware.js, express.js, data/main.mjson to application
  2. Add logic/service/foo-service.js, logic/model/foo.js, data/descriptors/foo.mjson, data/foo-service.mjson to application
  3. Add reference to foo-service.mjson in main.mjson

• If current working directory is an application and has stack

  1. Add logic/service/foo-service.js, logic/model/foo.js, data/descriptors/foo.mjson, data/foo-service.mjson to application
  2. Add reference to foo-service.mjson in main.mjson

[harold]

This looks interesting, but I think you were hoping to mention a different Harold.

[marchant]

I thought we had talked about creating a root "server" folder in the project, where all assets that are server side only would live