[amiddy] Ability to use a base configuration for defaults and placeholders and a specific config where you can define placeholder values.

Short description

Ability to use a base configuration for defaults and placeholders and a specific config where you can define placeholder values.

The problem

For amiddy, there is the ability to use a config file to define how the middleware will work.

There is the use-case where you have multiple environments for your application, and your configurations are just a copy/paste with minor changes.

Let's take an example. You are working for an Application that has 3 environments: acceptance, staging & production.
There should be 3 amiddy configs:
amiddy.acceptance.json:

{
  "source": {
    "ip": "127.0.0.1",
    "https": true,
    "port": 443
  },
  "deps": [
    {
      "name": "acceptance.gateway.example.com",
      "https": true,
      "port": 443,
      "patterns": [
        "/login",
        "/logout",
        "/api/**"
      ],
      "mocks": [
        {
          "patterns": ["info**"],
          "response": "",
          "status": 200,
          "fixture": "__local__/info.txt"
        }
      ]
    }
  ],
  "proxy": {
    "response": {
      "headers": {
        "X-Special-Proxy-Header": "on-response"
      }
    }
  },
  "vhost": {
    "name": "acceptance.example.com",
    "https": true,
    "port": 443
  }
}

amiddy.staging.json:

{
  "source": {
    "ip": "127.0.0.1",
    "https": true,
    "port": 443
  },
  "deps": [
    {
      "name": "staging.gateway.example.com",
      "https": true,
      "port": 443,
      "patterns": [
        "/login",
        "/logout",
        "/api/**"
      ],
      "mocks": [
        {
          "patterns": ["info**"],
          "response": "",
          "status": 200,
          "fixture": "__local__/info.txt"
        }
      ]
    }
  ],
  "proxy": {
    "response": {
      "headers": {
        "X-Special-Proxy-Header": "on-response"
      }
    }
  },
  "vhost": {
    "name": "staging.example.com",
    "https": true,
    "port": 443
  }
}

amiddy.production.json:

{
  "source": {
    "ip": "127.0.0.1",
    "https": true,
    "port": 443
  },
  "deps": [
    {
      "name": "production.gateway.example.com",
      "https": true,
      "port": 443,
      "patterns": [
        "/login",
        "/logout",
        "/api/**"
      ],
      "mocks": [
        {
          "patterns": ["info**"],
          "response": "",
          "status": 200,
          "fixture": "__local__/info.txt"
        }
      ]
    }
  ],
  "proxy": {
    "response": {
      "headers": {
        "X-Special-Proxy-Header": "on-response"
      }
    }
  },
  "vhost": {
    "name": "production.example.com",
    "https": true,
    "port": 443
  }
}

Now, what if I need to:

add a new mock?
add a new pattern for the dependency?
add a new dependency?
remove an existing pattern for the dependency?
...

I would need to change all 3 files every time and to add/remove the same stuff.

Solution

have a base config that contains placeholders
have a specific config that defined the placeholder and the value

Example, based on the above data:
base.amiddy.json

{
  "source": {
    "ip": "127.0.0.1",
    "https": true,
    "port": 443
  },
  "deps": [
    {
      "name": "__DEP_NAME__",
      "https": true,
      "port": 443,
      "patterns": [
        "/login",
        "/logout",
        "/api/**"
      ],
      "mocks": [
        {
          "patterns": ["info**"],
          "response": "",
          "status": 200,
          "fixture": "__local__/info.txt"
        }
      ]
    }
  ],
  "proxy": {
    "response": {
      "headers": {
        "X-Special-Proxy-Header": "on-response"
      }
    }
  },
  "vhost": {
    "name": "__VHOST_NAME__",
    "https": true,
    "port": 443
  }
}

amiddy.acceptance.json:

{
  "__DEP_NAME__": "acceptance.gateway.example.com",
  "__VHOST_NAME__": "acceptance.example.com"
}

staging.production.json:

{
  "__DEP_NAME__": "staging.gateway.example.com",
  "__VHOST_NAME__": "staging.example.com"
}

amiddy.production.json:

{
  "__DEP_NAME__": "production.gateway.example.com",
  "__VHOST_NAME__": "production.example.com"
}

If we are to answer the same questions are presented initially we need to change only the base config.

Notes

This implementation should not affect in any way existing behavior

all args, not just in catch?

I'm loving the babel auto logger. It's super helpful. I'm not seeing how to log the arguments for non-catch block calls. Is that possible? Thanks!

pauldcomanici / oia Goto Github PK

oia's People

Contributors

Stargazers

oia's Issues

[amiddy] Ability to use a base configuration for defaults and placeholders and a specific config where you can define placeholder values.

Short description

The problem

Solution

Notes

all args, not just in catch?

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent