Merge pull request #58 from adobe/json-pipeline

Simple JSON Pipeline

src/defaults/json.pipe.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2018 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+const { Pipeline } = require('../../index.js');
+const { adaptOWRequest, adaptOWResponse, log } = require('./default.js');
+
+const fetch = require('../html/fetch-markdown.js');
+const parse = require('../html/parse-markdown.js');
+const meta = require('../html/get-metadata.js');
+const type = require('../json/set-content-type.js');
+const smartypants = require('../html/smartypants');
+const sections = require('../html/split-sections');
+
+/* eslint no-param-reassign: off */
+
+const htmlpipe = (cont, payload, action) => {
+  action.logger = action.logger || log;
+  action.logger.log('debug', 'Constructing JSON Pipeline');
+  const pipe = new Pipeline(action);
+  pipe
+    .pre(adaptOWRequest)
+    .pre(fetch)
+    .pre(parse)
+    .pre(smartypants)
+    .pre(sections)
+    .pre(meta)
+    .once(cont)
+    .post(type)
+    .post(adaptOWResponse);
+
+  action.logger.log('debug', 'Running JSON pipeline');
+  return pipe.run(payload);
+};
+
+module.exports.pipe = htmlpipe;

src/defaults/json.pre.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright 2018 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+module.exports.pre = require('./default').pre;

src/json/set-content-type.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2018 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+function type({ response }, { logger }) {
+  // somebody already set a content type, keep as is
+  if (!(response && response.headers && response.headers['Content-Type'])) {
+    logger.debug('Setting content type header');
+    return {
+      response: {
+        headers: {
+          'Content-Type': 'application/json',
+        },
+      },
+    };
+  }
+  logger.debug('Keeping existing content type header');
+  return {};
+}
+module.exports = type;

test/testJSON.js

@@ -0,0 +1,139 @@
+/*
+ * Copyright 2018 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+/* eslint-env mocha */
+const assert = require('assert');
+const winston = require('winston');
+const { pipe } = require('../src/defaults/json.pipe.js');
+
+const logger = winston.createLogger({
+  // tune this for debugging
+  level: 'debug',
+  // and turn this on if you want the output
+  silent: true,
+  format: winston.format.simple(),
+  transports: [
+    new winston.transports.Console(),
+  ],
+});
+
+const params = {
+  path: '/hello.md',
+  __ow_method: 'get',
+  owner: 'trieloff',
+  __ow_headers: {
+    'X-Forwarded-Port': '443',
+    'X-CDN-Request-Id': '2a208a89-e071-44cf-aee9-220880da4c1e',
+    'Fastly-Client': '1',
+    'X-Forwarded-Host': 'runtime.adobe.io',
+    'Upgrade-Insecure-Requests': '1',
+    Host: 'controller-a',
+    Connection: 'close',
+    'Fastly-SSL': '1',
+    'X-Request-Id': 'RUss5tPdgOfw74a68aNc24FeTipGpVfW',
+    'X-Branch': 'master',
+    'Accept-Language': 'en-US, en;q=0.9, de;q=0.8',
+    'X-Forwarded-Proto': 'https',
+    'Fastly-Orig-Accept-Encoding': 'gzip',
+    'X-Varnish': '267021320',
+    DNT: '1',
+    'X-Forwarded-For':
+      '192.147.117.11, 157.52.92.27, 23.235.46.33, 10.64.221.107',
+    'X-Host': 'www.primordialsoup.life',
+    Accept:
+      'text/html, application/xhtml+xml, application/xml;q=0.9, image/webp, image/apng, */*;q=0.8',
+    'X-Real-IP': '10.64.221.107',
+    'X-Forwarded-Server': 'cache-lcy19249-LCY, cache-iad2127-IAD',
+    'Fastly-Client-IP': '192.147.117.11',
+    'Perf-Br-Req-In': '1529585370.116',
+    'X-Timer': 'S1529585370.068237,VS0,VS0',
+    'Fastly-FF':
+      'dc/x3e9z8KMmlHLQr8BEvVMmTcpl3y2YY5y6gjSJa3g=!LCY!cache-lcy19249-LCY, dc/x3e9z8KMmlHLQr8BEvVMmTcpl3y2YY5y6gjSJa3g=!LCY!cache-lcy19227-LCY, dc/x3e9z8KMmlHLQr8BEvVMmTcpl3y2YY5y6gjSJa3g=!IAD!cache-iad2127-IAD, dc/x3e9z8KMmlHLQr8BEvVMmTcpl3y2YY5y6gjSJa3g=!IAD!cache-iad2133-IAD',
+    'Accept-Encoding': 'gzip',
+    'User-Agent':
+      'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.87 Safari/537.36',
+  },
+  repo: 'soupdemo',
+  ref: 'master',
+  selector: 'md',
+  branch: 'master',
+};
+
+const secrets = {
+  REPO_RAW_ROOT: 'https://raw.githubusercontent.com/',
+};
+
+describe('Testing JSON Pipeline', () => {
+  it('json.pipe is a function', () => {
+    assert.ok(pipe);
+    assert.strictEqual(typeof pipe, 'function');
+  });
+
+  it('json.pipe makes HTTP requests', (done) => {
+    const result = pipe(
+      ({ content }) => {
+        // this is the main function (normally it would be the template function)
+        // but we use it to assert that pre-processing has happened
+        assert.ok(content.body);
+        assert.ok(content.mdast);
+        assert.ok(content.meta);
+        assert.equal('Medium', content.meta.template);
+        assert.equal('Project Helix', content.intro);
+        assert.equal('Bill, Welcome to the future', content.title);
+        // and return a different status code
+        return { response: { status: 201, body: { foo: 'bar' } } };
+      },
+      {},
+      {
+        request: { params },
+        secrets,
+        logger,
+      },
+    );
+
+    result.then((res) => {
+      assert.equal(201, res.statusCode);
+      assert.equal('application/json', res.headers['Content-Type']);
+      assert.deepEqual(res.body, { foo: 'bar' });
+      done();
+    });
+  });
+
+  it('json.pipe keeps Mime-Type', (done) => {
+    const result = pipe(
+      ({ content }) => {
+        // this is the main function (normally it would be the template function)
+        // but we use it to assert that pre-processing has happened
+        assert.ok(content.body);
+        assert.ok(content.mdast);
+        assert.ok(content.meta);
+        assert.equal('Medium', content.meta.template);
+        assert.equal('Project Helix', content.intro);
+        assert.equal('Bill, Welcome to the future', content.title);
+        // and return a different status code
+        return { response: { status: 201, body: { foo: 'bar' }, headers: { 'Content-Type': 'text/plain+json' } } };
+      },
+      {},
+      {
+        request: { params },
+        secrets,
+        logger,
+      },
+    );
+
+    result.then((res) => {
+      assert.equal(201, res.statusCode);
+      assert.equal('text/plain+json', res.headers['Content-Type']);
+      assert.deepEqual(res.body, { foo: 'bar' });
+      done();
+    });
+  });
+});