o2k: reorder object members to prettify the yaml output

Kong · Apr 29, 2021 · 67dd491 · 67dd491
1 parent bdb4b4e
commit 67dd491
Show file tree

Hide file tree

Showing 3 changed files with 67 additions and 6 deletions.
diff --git a/packages/openapi-2-kong/src/common.js b/packages/openapi-2-kong/src/common.js
@@ -170,3 +170,61 @@ export function distinctByProperty<T>(arr: Array<T>, propertySelector: (item: T)
   }
   return result;
 }
+
+function reorderObjectMembers(
+  objIn: any,
+  objOut: any,
+  first: Array<string>,
+  last: Array<string>,
+): any {
+  first.forEach(propName => {
+    if (typeof objIn[propName] !== 'undefined') {
+      objOut[propName] = objIn[propName];
+    }
+  });
+
+  for (const [propName, value] of Object.entries(objIn)) {
+    if (typeof objOut[propName] === 'undefined' && !last.includes(propName)) {
+      objOut[propName] = value;
+    }
+  }
+
+  last.forEach(propName => {
+    if (typeof objIn[propName] !== 'undefined') {
+      objOut[propName] = objIn[propName];
+    }
+  });
+  return objOut;
+}
+
+export function reorderService(service: DCService): DCService {
+  const first: Array<string> = ['name', 'protocol', 'host', 'port', 'path'];
+  const last: Array<string> = ['tags', 'plugins', 'routes'];
+  const serviceOut: DCService = {};
+  return reorderObjectMembers(service, serviceOut, first, last);
+}
+
+export function reorderUpstream(upstream: DCUpstream): DCUpstream {
+  const first: Array<string> = ['name'];
+  const last: Array<string> = ['tags', 'targets'];
+  const upstreamOut: DCUpstream = {};
+  return reorderObjectMembers(upstream, upstreamOut, first, last);
+}
+
+export function reorderRoute(route: DCRoute): DCRoute {
+  const first: Array<string> = ['name', 'paths', 'methods'];
+  const last: Array<string> = ['tags', 'plugins'];
+  const routeOut: DCRoute = {};
+  return reorderObjectMembers(route, routeOut, first, last);
+}
+
+export function reorderPlugins(plugins: Array<DCPlugin>): Array<DCPlugin> {
+  const first: Array<string> = ['name'];
+  const last: Array<string> = ['tags', 'config'];
+  const pluginsOut: Array<DCPlugin> = [];
+  plugins.forEach(plugin => {
+    const pluginOut: DCPlugin = {};
+    pluginsOut.push(reorderObjectMembers(plugin, pluginOut, first, last));
+  });
+  return pluginsOut;
+}
diff --git a/packages/openapi-2-kong/src/declarative-config/services.js b/packages/openapi-2-kong/src/declarative-config/services.js
@@ -8,6 +8,9 @@ import {
   pathVariablesToRegex,
   HttpMethod,
   parseUrl,
+  reorderService,
+  reorderRoute,
+  reorderPlugins,
 } from '../common';
 
 import { generateSecurityPlugins } from './security-plugins';
@@ -58,7 +61,7 @@ export function generateService(
     host: name, // not a hostname, but the Upstream name
     port: Number(parsedUrl.port || '80'),
     path: parsedUrl.pathname,
-    plugins: globalPlugins.plugins,
+    plugins: reorderPlugins(globalPlugins.plugins),
     routes: [],
     tags,
   };
@@ -139,14 +142,14 @@ export function generateService(
 
       // Add plugins if there are any
       if (plugins.length) {
-        route.plugins = plugins;
+        route.plugins = reorderPlugins(plugins);
       }
 
-      service.routes.push(route);
+      service.routes.push(reorderRoute(route));
     }
   }
 
-  return service;
+  return reorderService(service);
 }
 
 export function generateRouteName(

diff --git a/packages/openapi-2-kong/src/declarative-config/upstreams.js b/packages/openapi-2-kong/src/declarative-config/upstreams.js
@@ -1,6 +1,6 @@
 // @flow
 
-import { getName, parseUrl, fillServerVariables } from '../common';
+import { getName, parseUrl, fillServerVariables, reorderUpstream } from '../common';
 
 export function generateUpstreams(api: OpenApi3Spec, tags: Array<string>) {
   const servers = api.servers || [];
@@ -37,5 +37,5 @@ export function generateUpstreams(api: OpenApi3Spec, tags: Array<string>) {
     }
   }
 
-  return [upstream];
+  return [reorderUpstream(upstream)];
 }