#0: Scaffold out a very basic API service

pirog · pirog · commit 8be6154dff6e · 2019-12-13T10:33:21.000-05:00
diff --git a/.lando.yml b/.lando.yml
@@ -4,13 +4,24 @@ env_file:
 excludes:
   - node_modules
 proxy:
+  api:
+    - api.lndo.site:8011
   docs:
     - docs.lndo.site:8008
   site:
     - site.lndo.site:8009
   metrics:
     - metrics.lndo.site:8010
 services:
+  api:
+    type: node:10
+    build:
+      - yarn install
+    command: yarn run dev:api
+    overrides:
+      environment:
+        LANDO_API_PORT: 8011
+    port: 8011
   docs:
     type: node:10
     build:
diff --git a/.platform/routes.yaml b/.platform/routes.yaml
@@ -1,3 +1,14 @@
+# Api
+http://api.{default}/:
+  type: upstream
+  upstream: api:http
+  cache:
+    headers: ['Accept', 'Accept-Language', 'Origin']
+    default_ttl: 299
+    enabled: true
+  ssi:
+    enabled: false
+
 # Site
 http://devwithlando.io/:
   type: redirect
diff --git a/api/.platform.app.yaml b/api/.platform.app.yaml
@@ -0,0 +1,47 @@
+name: api
+type: nodejs:10
+
+dependencies:
+  nodejs:
+    pm2: "^2.0.0"
+    yarn: "*"
+
+web:
+  commands:
+    start: "PM2_HOME=$PLATFORM_APP_DIR/run pm2 start server.js --no-daemon"
+  locations:
+    "/public":
+      passthru: false
+      root: "public"
+      allow: true
+      rules:
+        '\.png$':
+          allow: true
+          expires: -1
+
+mounts:
+  "/run": "shared:files/run"
+
+disk: 1500
+
+hooks:
+  build: |
+    set -e
+    yarn install
+    curl -sS https://platform.sh/cli/installer | php
+
+crons:
+  snapshot:
+    # Take a snapshot automatically every night at 3 am (UTC).
+    spec: '0 3 * * *'
+    cmd: |
+      if [ "$PLATFORM_BRANCH" = master ]; then
+        /app/.platformsh/bin/platform snapshot:create --yes --no-wait
+      fi
+  renewcert:
+    # Force a redeploy at 9 am (UTC) on the 14th of every month.
+    spec: '0 9 14 * *'
+    cmd: |
+      if [ "$PLATFORM_BRANCH" = master ]; then
+        /app/.platformsh/bin/platform redeploy --yes --no-wait
+      fi
diff --git a/api/README.md b/api/README.md
@@ -0,0 +1,17 @@
+Lando API Server
+================
+
+Lightweight node server that powers the Lando API.
+
+Local Development
+-----------------
+
+### Installing
+
+Local development requires [lando](https://docs.lando.dev).
+
+```bash
+# Clone the entire lando project
+git clone https://github.com/lando/lando.git
+cd lando && lando start
+```
diff --git a/api/data/sponsors.yml b/api/data/sponsors.yml
@@ -0,0 +1,17 @@
+patriots:
+  - name: Tandem
+    logo: https://raw.githubusercontent.com/lando/lando/master/docs/.vuepress/public/images/tandem-pink.png
+    url: https://thinktandem.io
+partners:
+  - name: OpenDevShop
+    logo: https://avatars1.githubusercontent.com/u/6655472?s=200&v=4
+    url: http://getdevshop.com/
+teams:
+  - name: Lullabot
+    logo: https://www.drupal.org/files/Lullabot_Logo_Vertical-svg.png
+    url: https://www.lullabot.com/
+individuals:
+  - name: "@pirog"
+    url: https://twitter.com/pirogcommamike
+  - name: "@reynoldsalec"
+    url: https://twitter.com/reynoldsalec
diff --git a/api/lib/config.js b/api/lib/config.js
@@ -0,0 +1,35 @@
+'use strict';
+
+const _ = require('lodash');
+
+/*
+ * Helper to load the config things
+ */
+module.exports = (config = {}) => {
+  // Merge in .env file
+  require('dotenv').config();
+
+  // Merge in process.env as relevant
+  _.forEach(_.keys(config), key => {
+    if (_.has(process.env, key)) {
+      config[key] = process.env[key];
+    }
+  });
+
+  // Merge in platformsh stuff
+  if (!_.isEmpty(process.env.PLATFORM_ENVIRONMENT)) {
+    // Get platform config
+    const pconfig = require('platformsh').config();
+    // Load in platform consts
+    if (!_.isEmpty(pconfig.constiables)) {
+      _.forEach(pconfig.constiables, (value, key) => {
+        config[key] = value;
+      });
+    }
+    // Set the port
+    config.LANDO_API_PORT = pconfig.port;
+  }
+
+  // Return config
+  return config;
+};
diff --git a/api/lib/logger.js b/api/lib/logger.js
@@ -0,0 +1,39 @@
+'use strict';
+
+const _ = require('lodash');
+const winston = require('winston');
+const log = new winston.Logger({
+  transports: [
+    new winston.transports.Console({colorize: true}),
+  ],
+});
+
+/*
+ * Add a request logger method
+ */
+log.request = req => {
+  log.info(
+    '%s request to %s with body %j',
+    _.get(req, 'method', 'UNKNOWN'),
+    _.get(req, 'url', 'UNKNOWN'),
+    _.get(req, 'body', {})
+  );
+};
+
+/*
+ * Add a request logger method
+ */
+log.response = (res, type = 'info', data = {}) => {
+  log[type]('Responded with %s: %s',
+    _.get(res, 'statusCode', 'UNKNOWN'),
+    _.get(res, 'statusMessage', 'UNKNOWN')
+  );
+  log[type](data);
+};
+
+/*
+ * Return the log
+ */
+module.exports = log;
+
+
diff --git a/api/lib/utils.js b/api/lib/utils.js
@@ -0,0 +1,16 @@
+const fs = require('fs');
+const yaml = require('js-yaml');
+
+/*
+ * Helper to load a YAML file into a JS Object
+ *
+ * @TODO: we should mem cache these results and only read the file
+ * if its contents have changed
+ */
+exports.loadFile = file => {
+  try {
+    return yaml.safeLoad(fs.readFileSync(file));
+  } catch (e) {
+    throw Error(`Could not load file ${file}`);
+  }
+};
diff --git a/api/package.json b/api/package.json
@@ -0,0 +1,21 @@
+{
+  "name": "lando-api",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lando/lando"
+  },
+  "bugs": {
+    "email": "mike@lando.dev",
+    "url": "https://github.com/lando/lando"
+  },
+  "dependencies": {
+    "body-parser": "^1.14.2",
+    "compression": "^1.7.4",
+    "express": "^4.13.3",
+    "express-urlrewrite": "^1.2.0",
+    "js-yaml": "^3.13.1",
+    "lodash": "~4.17.13",
+    "platformsh": "^1.0.0",
+    "winston": "2.2"
+  }
+}
diff --git a/api/routes/index.js b/api/routes/index.js
@@ -0,0 +1,3 @@
+module.exports = (api, handler) => {
+  api.get('/v1', handler((req, res) => ({ping: 'pong'})));
+};
diff --git a/api/routes/sponsors.js b/api/routes/sponsors.js
@@ -0,0 +1,16 @@
+const path = require('path');
+const utils = require('./../lib/utils');
+const sponsorsFile = path.resolve(__dirname, '..', 'data', 'sponsors.yml');
+
+/*
+ * Helper to get
+ */
+
+module.exports = (api, handler) => {
+  api.get('/v1/sponsors', handler((req, res) => {
+    return utils.loadFile(sponsorsFile);
+  }));
+  api.get('/v1/sponsors/:type', handler((req, res) => {
+    return utils.loadFile(sponsorsFile)[req.params.type] || res.redirect('/sponsors');
+  }));
+};
diff --git a/api/server.js b/api/server.js
@@ -0,0 +1,75 @@
+'use strict';
+
+const bodyParser = require('body-parser');
+const compression = require('compression');
+const rewrite = require('express-urlrewrite');
+const fs = require('fs');
+const log = require('./lib/logger.js');
+const path = require('path');
+const Promise = require('bluebird');
+const currentVersion = 'v1';
+
+// Define default config
+const defaultConfig = {
+  'LANDO_API_PORT': 80,
+  'LANDO_API_TIMEOUT': 10000,
+};
+
+// Get configuration
+const config = require('./lib/config.js')(defaultConfig);
+log.info('Starting app with config %j', config);
+
+// Get the app ready
+const express = require('express');
+const api = express();
+
+// App usage
+api.use(compression());
+api.use(bodyParser.urlencoded({extended: true}));
+api.use(bodyParser.json());
+api.use(rewrite('/*', `/${currentVersion}/$1`));
+
+/**
+ * Handler function.
+ * @param {function} fn thing
+ * @return {String} log shit
+ */
+const handler = fn => {
+  // Returns a handler function.
+  return (req, res) => {
+    log.request(req, res);
+    // Call fn in context of a promise.
+    return Promise.try(fn, [req, res])
+    // Make sure we have a timeout.
+    .timeout(config.LANDO_API_TIMEOUT || 10 * 1000)
+    // Handle success.
+    .then(data => {
+      res.status(200);
+      res.json(data);
+      res.end();
+      log.response(res, 'info', data);
+    })
+    // Handler failure.
+    .catch(err => {
+      const code = err.statusCode || err.status || 500;
+      const message = err.message || err.statusMessage || 'Unknown Error';
+      res.status(code);
+      res.send({code, message});
+      res.end();
+      log.response(res, 'error', err);
+    });
+  };
+};
+
+// Start listening
+Promise.fromNode(cb => {
+  api.listen(config.LANDO_API_PORT, cb);
+})
+// Load our routes
+.then(() => {
+  fs.readdirSync(path.join(__dirname, 'routes')).map(file => {
+    require(`./routes/${file}`)(api, handler);
+    log.info('Loaded route %s', file);
+  });
+  log.info('Listening on port: %s', config.LANDO_API_PORT);
+});
diff --git a/api/yarn.lock b/api/yarn.lock
diff --git a/metrics/server.js b/metrics/server.js
diff --git a/package.json b/package.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = (api, handler) => {`
	`2`	`+ api.get('/v1', handler((req, res) => ({ping: 'pong'})));`
	`3`	`+};`