Merge pull request #146 from github/joshmgross/error-policy-option

Move `ErrorPolicy` into template converter options

actions-workflow-parser/src/model/convert.test.ts

@@ -19,7 +19,9 @@ jobs:
       nullTrace
     );
 
-    const template = await convertWorkflowTemplate(result.context, result.value!, ErrorPolicy.TryConversion);
+    const template = await convertWorkflowTemplate(result.context, result.value!, undefined, {
+      errorPolicy: ErrorPolicy.TryConversion
+    });
 
     expect(serializeTemplate(template)).toEqual({
       events: {
@@ -59,7 +61,9 @@ jobs:
       nullTrace
     );
 
-    const template = await convertWorkflowTemplate(result.context, result.value!, ErrorPolicy.TryConversion);
+    const template = await convertWorkflowTemplate(result.context, result.value!, undefined, {
+      errorPolicy: ErrorPolicy.TryConversion
+    });
 
     expect(serializeTemplate(template)).toEqual({
       events: {
@@ -105,7 +109,9 @@ jobs:
       nullTrace
     );
 
-    const template = await convertWorkflowTemplate(result.context, result.value!, ErrorPolicy.TryConversion);
+    const template = await convertWorkflowTemplate(result.context, result.value!, undefined, {
+      errorPolicy: ErrorPolicy.TryConversion
+    });
 
     expect(serializeTemplate(template)).toEqual({
       errors: [
@@ -152,7 +158,9 @@ jobs:
       nullTrace
     );
 
-    const template = await convertWorkflowTemplate(result.context, result.value!, ErrorPolicy.TryConversion);
+    const template = await convertWorkflowTemplate(result.context, result.value!, undefined, {
+      errorPolicy: ErrorPolicy.TryConversion
+    });
 
     expect(serializeTemplate(template)).toEqual({
       errors: [
@@ -229,7 +237,9 @@ jobs:
       nullTrace
     );
 
-    const template = await convertWorkflowTemplate(result.context, result.value!, ErrorPolicy.TryConversion);
+    const template = await convertWorkflowTemplate(result.context, result.value!, undefined, {
+      errorPolicy: ErrorPolicy.TryConversion
+    });
 
     expect(template.jobs).not.toBeUndefined();
     expect(template.jobs).toHaveLength(1);
@@ -282,7 +292,9 @@ jobs:
       nullTrace
     );
 
-    const template = await convertWorkflowTemplate(result.context, result.value!, ErrorPolicy.TryConversion);
+    const template = await convertWorkflowTemplate(result.context, result.value!, undefined, {
+      errorPolicy: ErrorPolicy.TryConversion
+    });
 
     expect(template.jobs).not.toBeUndefined();
     expect(template.jobs).toHaveLength(0);

actions-workflow-parser/src/model/convert.ts

@@ -31,31 +31,36 @@ export type WorkflowTemplateConverterOptions = {
    * Default: 0
    */
   fetchReusableWorkflowDepth?: number;
+
+  /**
+   * The error policy to use when converting the workflow.
+   * By default, conversion will be skipped if there are errors in the {@link TemplateContext}.
+   */
+  errorPolicy?: ErrorPolicy;
 };
 
 const defaultOptions: Required<WorkflowTemplateConverterOptions> = {
   maxReusableWorkflowDepth: 4,
-  fetchReusableWorkflowDepth: 0
+  fetchReusableWorkflowDepth: 0,
+  errorPolicy: ErrorPolicy.ReturnErrorsOnly
 };
 
 export async function convertWorkflowTemplate(
   context: TemplateContext,
   root: TemplateToken,
-  errorPolicy: ErrorPolicy = ErrorPolicy.ReturnErrorsOnly,
   fileProvider?: FileProvider,
   options: WorkflowTemplateConverterOptions = defaultOptions
 ): Promise<WorkflowTemplate> {
   const result = {} as WorkflowTemplate;
+  const opts = getOptionsWithDefaults(options);
 
-  if (context.errors.getErrors().length > 0 && errorPolicy === ErrorPolicy.ReturnErrorsOnly) {
+  if (context.errors.getErrors().length > 0 && opts.errorPolicy === ErrorPolicy.ReturnErrorsOnly) {
     result.errors = context.errors.getErrors().map(x => ({
       Message: x.message
     }));
     return result;
   }
 
-  const opts = getOptionsWithDefaults(options);
-
   if (fileProvider === undefined && opts.fetchReusableWorkflowDepth > 0) {
     context.error(root, new Error("A file provider is required to fetch reusable workflows"));
   }
@@ -136,6 +141,7 @@ function getOptionsWithDefaults(options: WorkflowTemplateConverterOptions): Requ
     fetchReusableWorkflowDepth:
       options.fetchReusableWorkflowDepth !== undefined
         ? options.fetchReusableWorkflowDepth
-        : defaultOptions.fetchReusableWorkflowDepth
+        : defaultOptions.fetchReusableWorkflowDepth,
+    errorPolicy: options.errorPolicy !== undefined ? options.errorPolicy : defaultOptions.errorPolicy
   };
 }

actions-workflow-parser/src/xlang.test.ts

@@ -85,7 +85,6 @@ describe("x-lang tests", () => {
       const workflowTemplate = await convertWorkflowTemplate(
         parseResult.context,
         parseResult.value!,
-        undefined,
         testFileProvider,
         {
           fetchReusableWorkflowDepth: 1