Parse toml files as well

Author: biilmann

common.js

@@ -0,0 +1,32 @@
+let URLclass = null
+
+function parseURL(url) {
+  if (typeof window !== 'undefined' && window.URL) {
+    return new window.URL(url)
+  }
+
+  URLclass = URLclass || require('url')
+  return URLclass.parse(url)
+}
+
+module.exports = {
+  FULL_URL_MATCHER: /^(https?):\/\/(.+)$/,
+  FORWARD_STATUS_MATCHER: /^2\d\d!?$/,
+
+  isInvalidSource: function(redirect) {
+    return redirect.path.match(/^\/\.netlify/)
+  },
+  isProxy: function(redirect) {
+    return redirect.proxy || (redirect.to.match(/^https?:\/\//) && redirect.status === 200)
+  },
+  parseFullOrigin: function(origin) {
+    let url = null
+    try {
+      url = parseURL(origin)
+    } catch (e) {
+      return null
+    }
+
+    return { host: url.host, scheme: url.protocol.replace(/:$/, ''), path: url.path }
+  }
+}

line-parser.js

@@ -1,50 +1,8 @@
-const FULL_URL_MATCHER = /^(https?):\/\/(.+)$/
-const FORWARD_STATUS_MATCHER = /^2\d\d!?$/
-
-let URLclass = null
-
-function parseURL(url) {
-  if (typeof window !== 'undefined' && window.URL) {
-    return new window.URL(url)
-  }
-
-  URLclass = URLclass || require('url')
-  return URLclass.parse(url)
-}
-
-class Result {
-  constructor() {
-    this.success = []
-    this.errors = []
-  }
-
-  addSuccess(redirect) {
-    this.success.push(redirect)
-  }
-
-  addError(idx, line, options) {
-    const reason = options && options.reason
-    this.errors.push({
-      lineNum: idx + 1,
-      line,
-      reason
-    })
-  }
-}
-
-function parseFullOrigin(origin) {
-  let url = null
-  try {
-    url = parseURL(origin)
-  } catch (e) {
-    return null
-  }
-
-  return { host: url.host, scheme: url.protocol.replace(/:$/, ''), path: url.path }
-}
+const Result = require('./result')
+const common = require('./common')
 
 function splatForwardRule(redirect, nextPart) {
-  return redirect.path.match(/\/\*$/) && nextPart.match(FORWARD_STATUS_MATCHER)
+  return redirect.path.match(/\/\*$/) && nextPart.match(common.FORWARD_STATUS_MATCHER)
 }
 
 function arrayToObj(source) {
@@ -77,15 +35,15 @@ function redirectMatch(line) {
   }
 
   const origin = parts.shift()
-  const redirect = origin.match(FULL_URL_MATCHER) ? parseFullOrigin(origin) : { path: origin }
+  const redirect = origin.match(common.FULL_URL_MATCHER) ? common.parseFullOrigin(origin) : { path: origin }
   if (redirect == null || !parts.length) {
     return null
   }
 
   if (splatForwardRule(redirect, parts[0])) {
     redirect.to = redirect.path.replace(/\/\*$/, '/:splat')
   } else {
-    const newHostRuleIdx = parts.findIndex(el => el.match(/^\//) || el.match(FULL_URL_MATCHER))
+    const newHostRuleIdx = parts.findIndex(el => el.match(/^\//) || el.match(common.FULL_URL_MATCHER))
     if (newHostRuleIdx < 0) {
       return null
     }
@@ -125,14 +83,6 @@ function redirectMatch(line) {
   return redirect
 }
 
-function isInvalidSource(redirect) {
-  return redirect.path.match(/^\/\.netlify/)
-}
-
-function isProxy(redirect) {
-  return redirect.proxy || (redirect.to.match(/^https?:\/\//) && redirect.status === 200)
-}
-
 function parse(text) {
   const result = new Result()
 
@@ -148,12 +98,12 @@ function parse(text) {
       return
     }
 
-    if (isInvalidSource(redirect)) {
+    if (common.isInvalidSource(redirect)) {
       result.addError(idx, line, { reason: 'Invalid /.netlify path in redirect source' })
       return
     }
 
-    if (isProxy(redirect)) {
+    if (common.isProxy(redirect)) {
       redirect.proxy = true
     }
 

package-lock.json

@@ -11,6 +11,9 @@
   ],
   "author": "Netlify",
   "license": "MIT",
+  "dependencies": {
+    "@iarna/toml": "^2.2.3"
+  },
   "devDependencies": {
     "ava": "^1.3.1"
   },

package.json

@@ -0,0 +1,21 @@
+class Result {
+  constructor() {
+    this.success = []
+    this.errors = []
+  }
+
+  addSuccess(redirect) {
+    this.success.push(redirect)
+  }
+
+  addError(idx, line, options) {
+    const reason = options && options.reason
+    this.errors.push({
+      lineNum: idx + 1,
+      line,
+      reason
+    })
+  }
+}
+
+module.exports = Result

result.js

@@ -0,0 +1,182 @@
+const test = require('ava')
+const parser = require('./toml-parser')
+
+test('simple redirects', t => {
+  const source = `
+redirects = [
+  {origin = "/home", destination = "/"},
+  {origin = "/admin/*", status = 200, force = true},
+  {origin = "/index", destination = "/", status = 302},
+  {from = "/from", to = "/to", status = 302}
+]`
+
+  const result = parser.parse(source)
+  t.deepEqual(
+    [
+      { path: '/home', to: '/' },
+      { path: '/admin/*', to: '/admin/:splat', status: 200, force: true },
+      { path: '/index', to: '/', status: 302 },
+      { path: '/from', to: '/to', status: 302 }
+    ],
+    result.success
+  )
+})
+
+test('redirects with parameter matches', t => {
+  const source = `
+    redirects = [
+          {origin = "/", destination = "/news", parameters = {page = "news"}},
+          {origin = "/blog", destination = "/blog/:post_id", parameters = {post = ":post_id"}},
+          {origin = "/", destination = "/about", parameters = {_escaped_fragment_ = "/about"},  status = 301}
+        ]
+  `
+
+  const result = parser.parse(source)
+  t.deepEqual(
+    [
+      { path: '/', to: '/news', params: { page: 'news' } },
+      { path: '/blog', to: '/blog/:post_id', params: { post: ':post_id' } },
+      { path: '/', to: '/about', params: { _escaped_fragment_: '/about' }, status: 301 }
+    ],
+    result.success
+  )
+})
+
+test('redirects with full hostname', t => {
+  const source = `
+redirects = [
+  {origin = "http://hello.bitballoon.com/*", destination = "http://www.hello.com/:splat"}
+]
+  `
+
+  const result = parser.parse(source)
+  t.deepEqual(
+    [{ host: 'hello.bitballoon.com', scheme: 'http', path: '/*', to: 'http://www.hello.com/:splat' }],
+    result.success
+  )
+})
+
+test('proxy instruction', t => {
+  const source = `
+  redirects = [
+          {origin = "/api/*", destination = "https://api.bitballoon.com/*", status = 200}
+  ]
+`
+
+  const result = parser.parse(source)
+  t.deepEqual([{ path: '/api/*', to: 'https://api.bitballoon.com/*', status: 200, proxy: true }], result.success)
+})
+
+test('headers on proxy rule', t => {
+  const source = `
+    redirects = [
+      {origin = "/", destination = "https://api.bitballoon.com", status = 200, headers = {anything = "something"}}
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.deepEqual(
+    [{ path: '/', to: 'https://api.bitballoon.com', status: 200, headers: { anything: 'something' }, proxy: true }],
+    result.success
+  )
+})
+
+test('redirect country conditions', t => {
+  const source = `
+    redirects = [
+      {origin = "/", destination = "/china", status = 302, conditions = {Country = ["ch", "tw"]}},
+      {origin = "/", destination = "/china", status = 302, conditions = {Country = ["il"], Language = ["en"]}}
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.deepEqual(
+    [
+      { path: '/', to: '/china', status: 302, conditions: { Country: ['ch', 'tw'] } },
+      { path: '/', to: '/china', status: 302, conditions: { Country: ['il'], Language: ['en'] } }
+    ],
+    result.success
+  )
+})
+
+test('rules with no destination', t => {
+  const source = `
+    redirects = [
+      {origin = "/swfobject.html?detectflash=false", status = 301}
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.is(0, result.success.length)
+  t.is(1, result.errors.length)
+})
+
+test('redirect role conditions', t => {
+  const source = `
+    redirects = [
+      {origin = "/admin/*", destination = "/admin/:splat", status = 200, conditions = {Role = ["admin"]}},
+      {origin = "/admin/*", destination = "/admin/:splat", status = 200, conditions = {Role = ["admin", "member"]}},
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.deepEqual(
+    [
+      { path: '/admin/*', to: '/admin/:splat', status: 200, conditions: { Role: ['admin'] } },
+      { path: '/admin/*', to: '/admin/:splat', status: 200, conditions: { Role: ['admin', 'member'] } }
+    ],
+    result.success
+  )
+})
+
+test('invalid headers on proxy rule', t => {
+  const source = `
+    redirects = [
+      {origin = "/", destination = "https://api.bitballoon.com", status = 200, headers = [{anything = "something"}]}
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.is(0, result.success.length)
+  t.is(1, result.errors.length)
+})
+
+test('missing origin in redirect rule', t => {
+  const source = `
+    redirects = [
+      {destination = "/index.html", status = 200}
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.is(0, result.success.length)
+  t.is(1, result.errors.length)
+})
+
+test('invalid netlify service source path', t => {
+  const source = `
+    redirects = [
+      {origin = "/.netlify/lfs", destination = "https://pawned.com"},
+      {origin = "https://example.com/.netlify/lfs", destination = "https://pawned.com"}
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.is(0, result.success.length)
+  t.is(2, result.errors.length)
+  result.errors.forEach(err => {
+    t.is('Invalid /.netlify path in redirect source', err.reason)
+  })
+})
+
+test('valid netlify service destination path', t => {
+  const source = `
+    redirects = [
+      {origin = "/api/*", destination = "/.netlify/function/:splat"},
+    ]
+  `
+
+  const result = parser.parse(source)
+  t.is(0, result.errors.length)
+  t.is(1, result.success.length)
+})