feat(build): Add support for resolver functions in _ref operator.

packages/build/src/build/buildRefs/getConfigFile.js

@@ -0,0 +1,39 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import { type } from '@lowdefy/helpers';
+
+async function getConfigFile({ context, refDef, referencedFrom }) {
+  if (!type.isString(refDef.path)) {
+    throw new Error(
+      `Invalid _ref definition ${JSON.stringify({
+        _ref: refDef.original,
+      })} in file ${referencedFrom}`
+    );
+  }
+
+  const content = context.readConfigFile(refDef.path);
+
+  if (content === null) {
+    throw new Error(
+      `Tried to reference file "${refDef.path}" from "${referencedFrom}", but file does not exist.`
+    );
+  }
+
+  return content;
+}
+
+export default getConfigFile;

packages/build/src/build/buildRefs/getRefContent.js

@@ -14,47 +14,19 @@
   limitations under the License.
 */
 
-import { type } from '@lowdefy/helpers';
-import { getFileExtension, getFileSubExtension } from '@lowdefy/node-utils';
-import JSON5 from 'json5';
-import YAML from 'js-yaml';
-
-import parseNunjucks from './parseNunjucks';
-
-function parseRefContent({ content, vars, path }) {
-  let ext = getFileExtension(path);
-  if (ext === 'njk') {
-    content = parseNunjucks(content, vars, path);
-    ext = getFileSubExtension(path);
-  }
-
-  if (ext === 'yaml' || ext === 'yml') {
-    return YAML.load(content);
-  }
-  if (ext === 'json') {
-    return JSON5.parse(content);
-  }
-  return content;
-}
+import getConfigFile from './getConfigFile';
+import parseRefContent from './parseRefContent';
+import runRefResolver from './runRefResolver';
 
 async function getRefContent({ context, refDef, referencedFrom }) {
-  if (!type.isString(refDef.path)) {
-    throw new Error(
-      `Invalid _ref definition ${JSON.stringify({
-        _ref: refDef.original,
-      })} in file ${referencedFrom}`
-    );
-  }
-
-  const { path, vars } = refDef;
   let content;
-  content = await context.readConfigFile(path);
-
-  if (content === null) {
-    throw new Error(`Tried to reference file with path "${path}", but file does not exist.`);
+  if (refDef.resolver) {
+    content = await runRefResolver({ context, refDef, referencedFrom });
+  } else {
+    content = await getConfigFile({ context, refDef, referencedFrom });
   }
 
-  return parseRefContent({ content, vars, path });
+  return parseRefContent({ content, refDef });
 }
 
 export default getRefContent;

packages/build/src/build/buildRefs/makeRefDefinition.js

@@ -22,10 +22,11 @@ import getRefPath from './getRefPath';
 function makeRefDefinition(refDefinition) {
   return {
     id: uuid(),
-    path: getRefPath(refDefinition),
-    vars: get(refDefinition, 'vars', { default: {} }),
-    transformer: get(refDefinition, 'transformer'),
     original: refDefinition,
+    path: getRefPath(refDefinition),
+    resolver: get(refDefinition, 'resolver'),
+    transformer: get(refDefinition, 'transformer'),
+    vars: get(refDefinition, 'vars', { default: {} }),
   };
 }
 

packages/build/src/build/buildRefs/parseRefContent.js

@@ -0,0 +1,43 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import { type } from '@lowdefy/helpers';
+import { getFileExtension, getFileSubExtension } from '@lowdefy/node-utils';
+import JSON5 from 'json5';
+import YAML from 'js-yaml';
+
+import parseNunjucks from './parseNunjucks';
+
+function parseRefContent({ content, refDef }) {
+  const { path, vars } = refDef;
+  if (type.isString(path)) {
+    let ext = getFileExtension(path);
+    if (ext === 'njk') {
+      content = parseNunjucks(content, vars);
+      ext = getFileSubExtension(path);
+    }
+
+    if (ext === 'yaml' || ext === 'yml') {
+      return YAML.load(content);
+    }
+    if (ext === 'json') {
+      return JSON5.parse(content);
+    }
+  }
+  return content;
+}
+
+export default parseRefContent;

packages/build/src/build/buildRefs/recursiveBuild.js

@@ -21,7 +21,7 @@ import runTransformer from './runTransformer';
 
 async function recursiveParseFile({ context, refDef, count, referencedFrom }) {
   // TODO: Maybe it would be better to detect a cycle, since this is the real issue here?
-  if (count > 20) {
+  if (count > 40) {
     throw new Error(`Maximum recursion depth of references exceeded.`);
   }
   let fileContent = await getRefContent({ context, refDef, referencedFrom });

packages/build/src/build/buildRefs/runRefResolver.js

@@ -0,0 +1,41 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+import { type } from '@lowdefy/helpers';
+import getUserJavascriptFunction from './getUserJavascriptFunction';
+
+async function runRefResolver({ context, refDef, referencedFrom }) {
+  const resolverFn = await getUserJavascriptFunction({
+    context,
+    filePath: refDef.resolver,
+  });
+  let content;
+  try {
+    content = await resolverFn(refDef.path, refDef.vars, context);
+  } catch (error) {
+    throw new Error(
+      `Error calling resolver "${refDef.resolver}" from "${referencedFrom}": ${error.message}`
+    );
+  }
+  if (type.isNone(content)) {
+    throw new Error(
+      `Tried to reference with resolver "${refDef.resolver}" from "${referencedFrom}", but received "${content}".`
+    );
+  }
+  return content;
+}
+
+export default runRefResolver;

packages/build/src/test/buildRefs/testBuildRefsAsyncFunction.js

@@ -0,0 +1,26 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+const wait = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+async function asyncFn() {
+  await wait(20);
+  return { async: true };
+}
+
+module.exports = asyncFn;

packages/build/src/test/buildRefs/testBuildRefsErrorResolver.js

@@ -0,0 +1,21 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+function resolver() {
+  throw new Error('Test error');
+}
+
+module.exports = resolver;

packages/build/src/test/buildRefs/testBuildRefsNullResolver.js

@@ -0,0 +1,22 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+function resolver(path) {
+  if (path === 'null') return null;
+  return undefined;
+}
+
+module.exports = resolver;

packages/build/src/test/buildRefs/testBuildRefsParsingResolver.js

@@ -0,0 +1,42 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+function resolver(path) {
+  switch (path) {
+    case 'target.yaml':
+      return `
+array:
+  - 1
+  - 2`;
+    case 'target.yml':
+      return `
+array:
+- 1
+- 2`;
+    case 'target.json':
+      return `{"a": 42}`;
+    case 'target.yaml.njk':
+      return 'a: {{ var }}';
+    case 'target.yml.njk':
+      return 'a: {{ var }}';
+    case 'target.json.njk':
+      return `{ "a": "{{ var }}" }`;
+    default:
+      return null;
+  }
+}
+
+module.exports = resolver;

packages/build/src/test/buildRefs/testBuildRefsResolver.js

@@ -0,0 +1,26 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+function resolver(path, vars, context) {
+  return {
+    resolved: true,
+    path,
+    vars,
+    context,
+  };
+}
+
+module.exports = resolver;

packages/build/src/test/buildRefs/testBuildRefsTransform.js

@@ -0,0 +1,29 @@
+/*
+  Copyright 2020-2021 Lowdefy, Inc
+
+  Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+function add(a, b) {
+  return a + b;
+}
+
+function transformer(obj, vars) {
+  return {
+    json: JSON.stringify(obj),
+    add: add(obj.a, 42),
+    var: vars.var1,
+  };
+}
+
+module.exports = transformer;

packages/build/src/test/testBuildRefsTransform.js

@@ -1,13 +0,0 @@
-function add(a, b) {
-  return a + b;
-}
-
-function transformer(obj, vars) {
-  return {
-    json: JSON.stringify(obj),
-    add: add(obj.a, 42),
-    var: vars.var1,
-  };
-}
-
-module.exports = transformer;