Refactor export mechanism to have a common grammar element instead of…

… distributing the publish keyword
jvalue · May 24, 2024 · 4fef7c4 · 4fef7c4
1 parent b94c29c
commit 4fef7c4
Show file tree

Hide file tree

Showing 38 changed files with 489 additions and 400 deletions.
diff --git a/libs/execution/src/lib/constraints/executors/allowlist-constraint-executor.spec.ts b/libs/execution/src/lib/constraints/executors/allowlist-constraint-executor.spec.ts
@@ -6,8 +6,8 @@ import {
   type BlockDefinition,
   type InternalValueRepresentation,
   type JayveeServices,
-  type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
@@ -18,6 +18,7 @@ import {
 import {
   type AstNode,
   type AstNodeLocator,
+  AstUtils,
   type LangiumDocument,
 } from 'langium';
 import { NodeFileSystem } from 'langium/node';
@@ -51,10 +52,15 @@ describe('Validation of AllowlistConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    const allElements = AstUtils.streamAllContents(document.parseResult.value);
+    const allConstraints = [...allElements.filter(isTypedConstraintDefinition)];
+    expect(
+      allConstraints.length > 0,
+      'No constraint definition found in test file',
+    );
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = allConstraints[0]!;
 
     return new AllowlistConstraintExecutor().isValid(
       value,

diff --git a/libs/execution/src/lib/constraints/executors/denylist-constraint-executor.spec.ts b/libs/execution/src/lib/constraints/executors/denylist-constraint-executor.spec.ts
@@ -6,8 +6,8 @@ import {
   type BlockDefinition,
   type InternalValueRepresentation,
   type JayveeServices,
-  type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
@@ -18,6 +18,7 @@ import {
 import {
   type AstNode,
   type AstNodeLocator,
+  AstUtils,
   type LangiumDocument,
 } from 'langium';
 import { NodeFileSystem } from 'langium/node';
@@ -51,10 +52,15 @@ describe('Validation of DenylistConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    const allElements = AstUtils.streamAllContents(document.parseResult.value);
+    const allConstraints = [...allElements.filter(isTypedConstraintDefinition)];
+    expect(
+      allConstraints.length > 0,
+      'No constraint definition found in test file',
+    );
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = allConstraints[0]!;
 
     return new DenylistConstraintExecutor().isValid(
       value,

diff --git a/libs/execution/src/lib/constraints/executors/expression-constraint-executor.spec.ts b/libs/execution/src/lib/constraints/executors/expression-constraint-executor.spec.ts
@@ -4,10 +4,10 @@
 
 import {
   type BlockDefinition,
-  type ExpressionConstraintDefinition,
   type InternalValueRepresentation,
   type JayveeServices,
   createJayveeServices,
+  isExpressionConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
@@ -18,6 +18,7 @@ import {
 import {
   type AstNode,
   type AstNodeLocator,
+  AstUtils,
   type LangiumDocument,
 } from 'langium';
 import { NodeFileSystem } from 'langium/node';
@@ -51,10 +52,17 @@ describe('Validation of AllowlistConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<ExpressionConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as ExpressionConstraintDefinition;
+
+    const allElements = AstUtils.streamAllContents(document.parseResult.value);
+    const allConstraints = [
+      ...allElements.filter(isExpressionConstraintDefinition),
+    ];
+    expect(
+      allConstraints.length > 0,
+      'No constraint definition found in test file',
+    );
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = allConstraints[0]!;
 
     return new ExpressionConstraintExecutor(constraint).isValid(
       value,

diff --git a/libs/execution/src/lib/constraints/executors/length-constraint-executor.spec.ts b/libs/execution/src/lib/constraints/executors/length-constraint-executor.spec.ts
@@ -6,8 +6,8 @@ import {
   type BlockDefinition,
   type InternalValueRepresentation,
   type JayveeServices,
-  type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
@@ -18,6 +18,7 @@ import {
 import {
   type AstNode,
   type AstNodeLocator,
+  AstUtils,
   type LangiumDocument,
 } from 'langium';
 import { NodeFileSystem } from 'langium/node';
@@ -51,10 +52,15 @@ describe('Validation of LengthConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    const allElements = AstUtils.streamAllContents(document.parseResult.value);
+    const allConstraints = [...allElements.filter(isTypedConstraintDefinition)];
+    expect(
+      allConstraints.length > 0,
+      'No constraint definition found in test file',
+    );
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = allConstraints[0]!;
 
     return new LengthConstraintExecutor().isValid(
       value,

diff --git a/libs/execution/src/lib/constraints/executors/range-constraint-executor.spec.ts b/libs/execution/src/lib/constraints/executors/range-constraint-executor.spec.ts
@@ -6,9 +6,9 @@ import {
   type BlockDefinition,
   type InternalValueRepresentation,
   type JayveeServices,
-  type TypedConstraintDefinition,
   createJayveeServices,
   initializeWorkspace,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
@@ -19,6 +19,7 @@ import {
 import {
   type AstNode,
   type AstNodeLocator,
+  AstUtils,
   type LangiumDocument,
 } from 'langium';
 import { NodeFileSystem } from 'langium/node';
@@ -52,10 +53,15 @@ describe('Validation of RangeConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    const allElements = AstUtils.streamAllContents(document.parseResult.value);
+    const allConstraints = [...allElements.filter(isTypedConstraintDefinition)];
+    expect(
+      allConstraints.length > 0,
+      'No constraint definition found in test file',
+    );
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = allConstraints[0]!;
 
     return new RangeConstraintExecutor().isValid(
       value,

diff --git a/libs/execution/src/lib/constraints/executors/regex-constraint-executor.spec.ts b/libs/execution/src/lib/constraints/executors/regex-constraint-executor.spec.ts
@@ -6,8 +6,8 @@ import {
   type BlockDefinition,
   type InternalValueRepresentation,
   type JayveeServices,
-  type TypedConstraintDefinition,
   createJayveeServices,
+  isTypedConstraintDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
@@ -18,6 +18,7 @@ import {
 import {
   type AstNode,
   type AstNodeLocator,
+  AstUtils,
   type LangiumDocument,
 } from 'langium';
 import { NodeFileSystem } from 'langium/node';
@@ -51,10 +52,15 @@ describe('Validation of RegexConstraintExecutor', () => {
       document.parseResult.value,
       'pipelines@0/blocks@2',
     ) as BlockDefinition;
-    const constraint = locator.getAstNode<TypedConstraintDefinition>(
-      document.parseResult.value,
-      'constraints@0',
-    ) as TypedConstraintDefinition;
+
+    const allElements = AstUtils.streamAllContents(document.parseResult.value);
+    const allConstraints = [...allElements.filter(isTypedConstraintDefinition)];
+    expect(
+      allConstraints.length > 0,
+      'No constraint definition found in test file',
+    );
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const constraint = allConstraints[0]!;
 
     return new RegexConstraintExecutor().isValid(
       value,

diff --git a/libs/execution/src/lib/transforms/transform-executor.spec.ts b/libs/execution/src/lib/transforms/transform-executor.spec.ts
@@ -9,8 +9,8 @@ import path from 'node:path';
 import {
   type InternalValueRepresentation,
   type JayveeServices,
-  type TransformDefinition,
   createJayveeServices,
+  isTransformDefinition,
 } from '@jvalue/jayvee-language-server';
 import {
   type ParseHelperOptions,
@@ -22,6 +22,7 @@ import {
 import {
   type AstNode,
   type AstNodeLocator,
+  AstUtils,
   type LangiumDocument,
 } from 'langium';
 import { NodeFileSystem } from 'langium/node';
@@ -77,10 +78,11 @@ describe('Validation of TransformExecutor', () => {
     const document = await parse(input, { validation: true });
     expectNoParserAndLexerErrors(document);
 
-    const transform = locator.getAstNode<TransformDefinition>(
-      document.parseResult.value,
-      'transforms@0',
-    ) as TransformDefinition;
+    const allElements = AstUtils.streamAllContents(document.parseResult.value);
+    const allTransforms = [...allElements.filter(isTransformDefinition)];
+    expect(allTransforms.length > 0);
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const transform = allTransforms[0]!;
 
     const executionContext = getTestExecutionContext(
       locator,

diff --git a/libs/language-server/src/grammar/block-type.langium b/libs/language-server/src/grammar/block-type.langium
@@ -14,12 +14,12 @@ ReferenceableBlockTypeDefinition:
   BuiltinBlockTypeDefinition | CompositeBlockTypeDefinition;
 
 BuiltinBlockTypeDefinition:
-    (isPublished?='publish')? 'builtin' 'blocktype' name=ID '{'
+    'builtin' 'blocktype' name=ID '{'
         (inputs+=BlockTypeInput | outputs+=BlockTypeOutput | properties+=BlockTypeProperty)*
 '}';
 
 CompositeBlockTypeDefinition:
-    (isPublished?='publish')? 'composite' 'blocktype' name=ID '{'
+    'composite' 'blocktype' name=ID '{'
         (
             inputs+=BlockTypeInput
             | outputs+=BlockTypeOutput

diff --git a/libs/language-server/src/grammar/constraint.langium b/libs/language-server/src/grammar/constraint.langium
@@ -11,13 +11,13 @@ ConstraintDefinition:
   TypedConstraintDefinition | ExpressionConstraintDefinition;
 
 TypedConstraintDefinition:
-  (isPublished?='publish')? 'constraint' name=ID 'oftype' type=[BuiltinConstrainttypeDefinition] body=PropertyBody;
+  'constraint' name=ID 'oftype' type=[BuiltinConstrainttypeDefinition] body=PropertyBody;
 
 ExpressionConstraintDefinition:
-  (isPublished?='publish')? 'constraint' name=ID 'on' valueType=ValueTypeReference ':' expression=Expression ';';
+  'constraint' name=ID 'on' valueType=ValueTypeReference ':' expression=Expression ';';
 
 BuiltinConstrainttypeDefinition:
-  (isPublished?='publish')? 'builtin' 'constrainttype' name=ID 'on' valueType=ValueTypeReference '{'
+  'builtin' 'constrainttype' name=ID 'on' valueType=ValueTypeReference '{'
     (properties+=ConstrainttypeProperty)*
 '}';
 

diff --git a/libs/language-server/src/grammar/io-type.langium b/libs/language-server/src/grammar/io-type.langium
@@ -6,4 +6,4 @@ import './expression'
 import './terminal'
 
 IotypeDefinition:
-    (isPublished?='publish')? 'builtin' 'iotype' name=ID ';';
+    'builtin' 'iotype' name=ID ';';
diff --git a/libs/language-server/src/grammar/main.langium b/libs/language-server/src/grammar/main.langium
@@ -17,27 +17,20 @@ entry JayveeModel:
   (
     imports+=ImportDefinition
     | exports+=ExportDefinition
+    | exportableElements+=ExportableElementDefinition
     | pipelines+=PipelineDefinition
-    | valueTypes+=(CustomValuetypeDefinition | BuiltinValuetypeDefinition)
-    | constraints+=ConstraintDefinition
-    | transforms+=TransformDefinition
-    | blockTypes+=ReferenceableBlockTypeDefinition
-    | constrainttypes+=BuiltinConstrainttypeDefinition
-    | iotypes+=IotypeDefinition
   )*;
 
-// When adding an element here, make sure the element has the following prependix in its rule
-// (isPublished?='publish')?
-// TypeScript lets us then infer that there is a field `isPublished` after using the type guard `isExportableElement`.
-ExportableElement:
-  // Must ref rules where isPublished is defined 
-  // So don't use aggregates like ReferenceableBlockTypeDefinition
-  // Otherwise it doesn't work to resolve the refenerces
+ExportableElementDefinition:
+  (isPublished?='publish')? ExportableElement;
+
+ExportableElement: 
   (CustomValuetypeDefinition | BuiltinValuetypeDefinition)
-  | (TypedConstraintDefinition | ExpressionConstraintDefinition | BuiltinConstrainttypeDefinition)
-  | TransformDefinition
-  | (BuiltinBlockTypeDefinition | CompositeBlockTypeDefinition) 
-  | IotypeDefinition;
+    | ConstraintDefinition
+    | TransformDefinition
+    | ReferenceableBlockTypeDefinition
+    | BuiltinConstrainttypeDefinition
+    | IotypeDefinition;
 
 ExportDefinition:
   'publish' element=[ExportableElement] ';';

diff --git a/libs/language-server/src/grammar/transform.langium b/libs/language-server/src/grammar/transform.langium
@@ -7,7 +7,7 @@ import 'value-type'
 import 'expression'
 
 TransformDefinition:
-  (isPublished?='publish')? 'transform' name=ID body=TransformBody;
+  'transform' name=ID body=TransformBody;
 
 TransformBody:
   '{' (ports+=TransformPortDefinition)* (outputAssignments+=TransformOutputAssignment)* '}';

diff --git a/libs/language-server/src/grammar/value-type.langium b/libs/language-server/src/grammar/value-type.langium
@@ -6,12 +6,12 @@ import './expression'
 import './terminal'
 
 BuiltinValuetypeDefinition infers ValuetypeDefinition:
-  (isPublished?='publish')? isBuiltin?='builtin' 'valuetype' name=ID 
+  isBuiltin?='builtin' 'valuetype' name=ID 
     (genericDefinition=ValuetypeGenericsDefinition)?
   ';';
 
 CustomValuetypeDefinition infers ValuetypeDefinition:
-  (isPublished?='publish')? 'valuetype' name=ID 
+  'valuetype' name=ID 
     (genericDefinition=ValuetypeGenericsDefinition)?
   'oftype' type=ValueTypeReference '{'
     'constraints' ':' constraints=CollectionLiteral ';'