@loopback/example-lb3-application 3.0.1

package/lb3app/server/server.js

@@ -0,0 +1,17 @@
+// Copyright IBM Corp. 2019,2020. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+
+const loopback = require('loopback');
+const boot = require('loopback-boot');
+
+const app = (module.exports = loopback());
+
+// Bootstrap the application, configure models, datasources and middleware.
+// Sub-apps like REST API are mounted via boot scripts.
+boot(app, __dirname, function (err) {
+  if (err) throw err;
+});

package/lb3app/test/acceptance.js

@@ -0,0 +1,107 @@
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+const {supertest} = require('@loopback/testlab');
+const assert = require('assert');
+const {ExpressServer} = require('../../dist/server');
+const {CoffeeShopApplication} = require('../../dist/application');
+require('should');
+
+let app;
+
+function jsonForLB4(verb, url) {
+  // use the lb4 app's rest server
+  return supertest(app.restServer.url)
+    [verb](url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .expect('Content-Type', /json/);
+}
+
+function jsonForExpressApp(verb, url) {
+  // use the express server, it mounts LoopBack 3 apis to
+  // base path '/api'
+  return supertest(app.server)
+    [verb]('/api' + url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .expect('Content-Type', /json/);
+}
+
+function jsonForExternal(verb, url) {
+  // use the express server, its external apis doesn't have base path
+  return supertest(app.server)
+    [verb](url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .expect('Content-Type', /json/);
+}
+
+describe('LoopBack 3 style acceptance tests - boot from Express server', function () {
+  before(async function () {
+    app = new ExpressServer();
+    await app.boot();
+    await app.start();
+  });
+
+  after(async () => {
+    await app.stop();
+  });
+
+  it('gets external route in application', function (done) {
+    jsonForExternal('get', '/ping').expect(200, function (err, res) {
+      assert.equal(res.text, 'pong');
+      done();
+    });
+  });
+
+  runTests(jsonForExpressApp);
+});
+
+describe('LoopBack 3 style acceptance tests - boot from LB4 app', function () {
+  before(async function () {
+    app = new CoffeeShopApplication();
+    await app.boot();
+    await app.start();
+  });
+
+  after(async () => {
+    await app.stop();
+  });
+
+  runTests(jsonForLB4);
+});
+
+function runTests(request) {
+  context('basic REST calls for LoopBack 3 application', () => {
+    it('creates and finds a CoffeeShop', function (done) {
+      request('post', '/CoffeeShops')
+        .send({
+          name: 'Coffee Shop',
+          city: 'Toronto',
+        })
+        .expect(200)
+        .end(function (err, res) {
+          assert(typeof res.body === 'object');
+          assert(res.body.name);
+          assert(res.body.city);
+          assert.equal(res.body.name, 'Coffee Shop');
+          assert.equal(res.body.city, 'Toronto');
+          done();
+        });
+    });
+
+    it("gets the CoffeeShop's status", function (done) {
+      request('get', '/CoffeeShops/status').expect(200, function (err, res) {
+        res.body.status.should.be.equalOneOf(
+          'We are open for business.',
+          'Sorry, we are closed. Open daily from 6am to 8pm.',
+        );
+        done();
+      });
+    });
+  });
+}

package/lb3app/test/authentication.js

@@ -0,0 +1,135 @@
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+const lb3App = require('../server/server');
+const {supertest} = require('@loopback/testlab');
+const assert = require('assert');
+const {ExpressServer} = require('../../dist/server');
+const {CoffeeShopApplication} = require('../../dist/application');
+require('should');
+
+let app, User;
+
+function jsonForLB4(verb, url) {
+  // use the lb4 app's rest server
+  return supertest(app.restServer.url)
+    [verb](url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .expect('Content-Type', /json/);
+}
+
+function jsonForExpressApp(verb, url) {
+  // use the express server, it mounts apis to base path '/api'
+  return supertest(app.server)
+    [verb]('/api' + url)
+    .set('Content-Type', 'application/json')
+    .set('Accept', 'application/json')
+    .expect('Content-Type', /json/);
+}
+
+/**
+ * The tests show running LoopBack 3 authentication tests mounted to
+ * an Express server.
+ * Make sure you start the express server first and stop it after tests done.
+ */
+describe('LoopBack 3 authentication - Express server', function () {
+  before(async function () {
+    User = lb3App.models.User;
+    app = new ExpressServer();
+    await app.boot();
+    await app.start();
+  });
+
+  after(async () => {
+    await User.destroyAll();
+    await app.stop();
+  });
+
+  runTests(jsonForExpressApp);
+});
+
+/**
+ * The tests show running LoopBack 3 authentication tests mounted to
+ * a LoopBack 4 application.
+ * Make sure you start the LoopBack 4 application first and stop it
+ * after tests done.
+ */
+describe('Loopback 3 authentication - LoopBack 4 app', function () {
+  before(async function () {
+    User = lb3App.models.User;
+    app = new CoffeeShopApplication();
+    await app.boot();
+    await app.start();
+  });
+
+  after(async () => {
+    await User.destroyAll();
+    await app.stop();
+  });
+
+  runTests(jsonForLB4);
+});
+
+function runTests(request) {
+  it('creates a User and logs them in and out', function (done) {
+    // create user
+    request('post', '/users')
+      .send({email: 'new@email.com', password: 'L00pBack!'})
+      .expect(200, function (err, user) {
+        assert.equal(user.body.email, 'new@email.com');
+        // login
+        request('post', '/users/login')
+          .send({
+            email: 'new@email.com',
+            password: 'L00pBack!',
+          })
+          .expect(200, function (err2, token) {
+            token.body.should.have.properties('ttl', 'userId', 'created', 'id');
+            assert.equal(token.body.userId, user.body.id);
+            // logout
+            request(
+              'post',
+              `/users/logout?access_token=${token.body.id}`,
+            ).expect(204);
+            done();
+          });
+      });
+  });
+
+  it('rejects anonymous requests to protected endpoints', function (done) {
+    request('get', '/CoffeeShops/greet').expect(401, function (err, res) {
+      assert.equal(res.body.error.code, 'AUTHORIZATION_REQUIRED');
+    });
+    done();
+  });
+
+  it('makes an authenticated request', function (done) {
+    // create user
+    User.create(
+      {email: 'new@gmail.com', password: 'L00pBack!'},
+      function (err, user) {
+        user.email.should.be.equal('new@gmail.com');
+        // login
+        User.login(
+          {email: 'new@gmail.com', password: 'L00pBack!'},
+          function (err2, token) {
+            assert.equal(typeof token, 'object');
+            assert.equal(token.userId, user.id);
+            // authenticate user with token
+            request(
+              'get',
+              `/CoffeeShops/greet?access_token=${token.id}`,
+            ).expect(200, function (err3, res) {
+              res.body.greeting.should.be.equal('Hello from this Coffee Shop');
+              done();
+            });
+          },
+        );
+      },
+    );
+  });
+}

package/lb3app/test/integration.js

@@ -0,0 +1,75 @@
+// Copyright IBM Corp. 2020. All Rights Reserved.
+// Node module: @loopback/example-lb3-application
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+'use strict';
+
+const assert = require('assert');
+const ExpressServer = require('../../dist/server').ExpressServer;
+const CoffeeShopApp = require('../../dist/application').CoffeeShopApplication;
+require('should');
+
+let CoffeeShop, app;
+
+describe('LoopBack 3 style integration tests - boot from LB4 app', function () {
+  before(async function () {
+    app = new CoffeeShopApp();
+    await app.boot();
+    await app.start();
+    CoffeeShop = await app.get('lb3-models.CoffeeShop');
+  });
+
+  after(async () => {
+    await CoffeeShop.destroyAll({name: 'Nook Shop'});
+    await app.stop();
+  });
+
+  runTests();
+});
+
+describe('LoopBack 3 style integration tests - boot from express', function () {
+  before(async () => {
+    app = new ExpressServer();
+    await app.boot();
+    await app.start();
+    CoffeeShop = await app.lbApp.get('lb3-models.CoffeeShop');
+  });
+
+  after(async () => {
+    await app.stop();
+  });
+
+  runTests();
+});
+
+function runTests() {
+  it('CoffeeShop.find', function (done) {
+    CoffeeShop.find({where: {name: 'Bel Cafe'}}, function (err, shop) {
+      shop[0].__data.name.should.be.equal('Bel Cafe');
+      shop[0].__data.city.should.be.equal('Vancouver');
+    });
+    done();
+  });
+
+  it('CoffeeShop.count', function (done) {
+    CoffeeShop.count({}, function (err, count) {
+      assert.equal(count, 6);
+    });
+    done();
+  });
+
+  it('CoffeeShop.create', function (done) {
+    CoffeeShop.create(
+      {
+        name: 'Nook Shop',
+        city: 'Toronto',
+      },
+      function (err, shop) {
+        shop.__data.name.should.be.equal('Nook Shop');
+        shop.__data.city.should.be.equal('Toronto');
+      },
+    );
+    done();
+  });
+}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@loopback/example-lb3-application",
+  "description": "Tutorial example on how to add existing an LB3 application to a LB4 project",
+  "version": "3.0.1",
+  "keywords": [
+    "loopback",
+    "LoopBack",
+    "example"
+  ],
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "examples/lb3-application"
+  },
+  "engines": {
+    "node": "^10.16 || 12 || 14 || 16"
+  },
+  "scripts": {
+    "build": "lb-tsc",
+    "build:watch": "lb-tsc --watch",
+    "clean": "lb-clean *example-lb3-application*.tgz dist *.tsbuildinfo package",
+    "lint": "npm run prettier:check && npm run eslint",
+    "lint:fix": "npm run eslint:fix && npm run prettier:fix",
+    "prettier:cli": "lb-prettier \"**/*.ts\"",
+    "prettier:check": "npm run prettier:cli -- -l",
+    "prettier:fix": "npm run prettier:cli -- --write",
+    "eslint": "lb-eslint --report-unused-disable-directives .",
+    "eslint:fix": "npm run eslint -- --fix",
+    "pretest": "npm run rebuild",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\" \"lb3app/test/*.js\"",
+    "test:dev": "lb-mocha --allow-console-logs dist/__tests__/**/*.js && npm run posttest",
+    "verify": "npm pack && tar xf loopback-lb3-application*.tgz && tree package && npm run clean",
+    "premigrate": "npm run build ",
+    "migrate": "node ./dist/migrate",
+    "preopenapi-spec": "npm run build",
+    "openapi-spec": "node ./dist/openapi-spec",
+    "rebuild": "npm run clean && npm run build",
+    "prestart": "npm run rebuild",
+    "start": "node ."
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@loopback/boot": "^3.4.3",
+    "@loopback/booter-lb3app": "^2.4.3",
+    "@loopback/core": "^2.17.0",
+    "@loopback/repository": "^3.7.2",
+    "@loopback/rest": "^10.0.1",
+    "@loopback/rest-explorer": "^3.3.3",
+    "compression": "^1.7.4",
+    "cors": "^2.8.5",
+    "debug": "^4.3.2",
+    "express": "^4.17.1",
+    "helmet": "^4.6.0",
+    "loopback": "^3.28.0",
+    "loopback-boot": "^3.3.1",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^7.0.1",
+    "@loopback/eslint-config": "^11.0.1",
+    "@loopback/rest": "^10.0.1",
+    "@loopback/testlab": "^3.4.3",
+    "@types/lodash": "^4.14.173",
+    "@types/node": "^10.17.60",
+    "eslint": "^7.32.0",
+    "lodash": "^4.17.21",
+    "should": "^13.2.3",
+    "typescript": "~4.3.5"
+  },
+  "gitHead": "1df36bb1ee2e513d9e197bd6010c4cfb296d50b8"
+}

package/public/index.html

@@ -0,0 +1,74 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <title>@loopback/example-lb3-application</title>
+
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="shortcut icon" type="image/x-icon" href="//loopback.io/favicon.ico">
+
+  <style>
+    h3 {
+      margin-left: 25px;
+      text-align: center;
+    }
+
+    a, a:visited {
+      color: #3f5dff;
+    }
+
+    h3 a {
+      margin-left: 10px;
+    }
+
+    a:hover, a:focus, a:active {
+      color: #001956;
+    }
+
+    .power {
+      position: absolute;
+      bottom: 25px;
+      left: 50%;
+      transform: translateX(-50%);
+    }
+
+    .info {
+      position: absolute;
+      top: 50%;
+      left: 50%;
+      transform: translate(-50%, -50%)
+    }
+
+    .info h1 {
+      text-align: center;
+      margin-bottom: 0
+    }
+
+    .info p {
+      text-align: center;
+      margin-bottom: 3em;
+      margin-top: 1em;
+    }
+  </style>
+</head>
+
+<body>
+  <div class="info">
+    <h1>@loopback/example-lb3-application</h1>
+
+    <h3>OpenAPI spec: <a href="/api/openapi.json">/openapi.json</a></h3>
+    <h3>API Explorer: <a href="/api/explorer">/explorer</a></h3>
+    <h3><a href="/lb3-index.html">Home page from the LB3 app</a></h3>
+  </div>
+
+  <footer class="power">
+    <a href="https://loopback.io" target="_blank">
+      <img src="https://loopback.io/images/branding/powered-by-loopback/blue/powered-by-loopback-sm.png" />
+    </a>
+  </footer>
+</body>
+
+</html>
+