Refactoring: Define Blocktypes solely in Code #445

georg-schwarz · 2023-09-04T17:05:59Z

This PR removes the need for language extensions - the execution extensions are not touched. Therfore, the BlockMetaInformation becomes more of a wrapper class for the AST elements.

This will also resolve #435 as soon as we do the same for constraints.

Next steps

do the same for Constraints.
move constraint evalution from execution to the language-server to allow their usage for blocktype properties.

… registry item

libs/language-server/src/stdlib/builtin-blocktypes/TextRangeSelector.jv

georg-schwarz

I started this PR today and ran into some dead ends. Especially expressing the validation logic in Jayvee itself is not there yet.. Any ideas how to approach it @rhazn ?

You can find the specific code snippets when looking at the jv blocktype definitions where I left a TODO, I marked two exemplary ones as conversation.

libs/language-server/src/stdlib/builtin-blocktypes/TableTransformer.jv

libs/language-server/src/stdlib/builtin-blocktypes/RowDeleter.jv

…ations

…tions

…ions

…dations

…tions

…ions

georg-schwarz · 2023-09-07T16:12:20Z

libs/interpreter-lib/src/std-extension.spec.ts

-      );
+  it('should provide matching block executors for builtin block types', async () => {
+    useStdExtension();
+    (await getAllBuiltinBlocktypes()).forEach(


Unfortunately, I wasn't able to pull that out so that each blocktype has its own test case. Issue is the asynchronous nature of loading the builtin blocktypes. Requires some further digging I guess.

The function getAllBuildinBlocktypes might be a good candidate to pull out and add as util functionality to the interpreter-lib

Pulled out function to model-util.

libs/interpreter-lib/src/validation-checks/runtime-parameter-literal.ts

libs/language-server/src/lib/jayvee-module.ts

georg-schwarz · 2023-09-07T16:17:15Z

libs/language-server/src/lib/meta-information/block-meta-inf.ts

+    const outputPort = blocktypeDefinition.outputs[0];
+    assert(outputPort !== undefined);
+    this.outputType = getIOType(outputPort);
+  }


Design decision: I did not extract docs here since that would require the JayveeServices to be injected. However, we don't have it available at all places where we construct this class. Would be too big of a refactoring, so I chose to leave that out and extract the docs from comments in the docs generator instead. Might influence the hovering support of Jayvee.

georg-schwarz · 2023-09-07T16:18:47Z

libs/language-server/src/lib/meta-information/block-meta-inf.ts

@@ -15,21 +24,90 @@ interface BlockDocs {
  examples?: ExampleDoc[];
 }

-export abstract class BlockMetaInformation extends MetaInformation {
+export class BlockMetaInformation extends MetaInformation {


This class basically became an AST wrapper (like Valuetype and others). I did not move it yet as I'd like to have the MetaInformation stuff cohesively in one place. Would move them as soon as we did the same for Constraints.

libs/language-server/src/lib/services/jayvee-documentation-provider.ts

georg-schwarz · 2023-10-12T09:23:46Z

apps/docs/docs/dev/04-guides/06-jayvee-extensions.md

+:::info
+This mechanism is currently under construction! We are moving from a code-first approach (using typescript classes to generate the Jayvee model of the blocktype) to a model-first approach (parsing the Jayvee model of the blocktype and creating ast wrappers). 
+:::


We should not use these info boxes!

Addressed in 48b883c

georg-schwarz · 2023-10-12T09:40:56Z

libs/language-server/src/lib/ast/model-util.ts

+          return;
+        }
+        if (BlockMetaInformation.canBeWrapped(blocktypeDefinition)) {
+          allBuiltinBlocktypes.push(


TODO: duplicate blocktype definition

Addressed in 7d98ae4

rhazn

Pair reviewed in meeting.

georg-schwarz added 4 commits September 4, 2023 14:08

Document constraint types in-code

ab785d9

Separate block and constraint meta inf registries

977d42f

Started refactoring BlockMetaInformation to be a wrapper instead of a…

d2dc2ca

… registry item

Adapt tests to removal of extensions

ff1dacb

georg-schwarz commented Sep 4, 2023

View reviewed changes

libs/language-server/src/stdlib/builtin-blocktypes/TextRangeSelector.jv Outdated Show resolved Hide resolved

Replace lang extensions by builtin blocktype definitions

a1f5ffe

georg-schwarz force-pushed the block-meta-inf-in-code branch from ea637aa to a1f5ffe Compare September 4, 2023 17:07

georg-schwarz commented Sep 4, 2023

View reviewed changes

libs/language-server/src/stdlib/builtin-blocktypes/TableTransformer.jv Outdated Show resolved Hide resolved

georg-schwarz commented Sep 4, 2023

View reviewed changes

libs/language-server/src/stdlib/builtin-blocktypes/RowDeleter.jv Outdated Show resolved Hide resolved

georg-schwarz added 21 commits September 5, 2023 14:00

Fix build and linter of remaining apps/libs

249c856

Remove test.jv

8f9da7e

Move validations from ArchiveInterpreter to property assignment valid…

27d62f1

…ations

Move validations from CellWriter to property assignment validations

4f26f7d

Move validations from ColumnDeleter to property assignment validations

575cad4

Move validations from GtfsRTInterpreter to property assignment valida…

8e8c185

…tions

Test ArchiveInterpreter custom validation

4363920

Fix too eager validation

d8a5605

Move validations from HttpExtractor to property assignment validations

72866d5

Move validations from RowDeleter to property assignment validations

529f928

Move validations from TableInterpreter to property assignment validat…

d73e1d7

…ions

Move validations from TextFileInterpreter to property assignment vali…

e392224

…dations

Move validations from TextLineDeleter to property assignment validations

bd50a8e

Move validations from TextRangeSelector to property assignment valida…

cc2a58d

…tions

Refactor blocktype specific property validations into own file

8cb933c

Pull out checkPropertyValueOneOf function

8536b44

Move body validations from TextRangeSelector to property body validat…

2a5d826

…ions

Move body validations from CellWriter to property body validations

f087692

Move body validations from TableTransformer to property body validations

a3861f9

Move body validations from TableTransformer to property body validations

d249c7e

Resolve TODO in runtime parameter literal validation

6337d40

georg-schwarz added 2 commits September 7, 2023 17:53

Add documentation for properties of blocktypes reading from jv comment

55abaa6

Pull out method extractDocsFromComment

ca72b28

georg-schwarz commented Sep 7, 2023

View reviewed changes

libs/interpreter-lib/src/validation-checks/runtime-parameter-literal.ts Outdated Show resolved Hide resolved

georg-schwarz commented Sep 7, 2023

View reviewed changes

libs/language-server/src/lib/jayvee-module.ts Outdated Show resolved Hide resolved

georg-schwarz commented Sep 7, 2023

View reviewed changes

libs/language-server/src/lib/services/jayvee-documentation-provider.ts Outdated Show resolved Hide resolved

Improve assertion messages

d0ad929

georg-schwarz marked this pull request as ready for review September 7, 2023 16:21

georg-schwarz and others added 8 commits September 7, 2023 18:25

Merge branch 'main' into block-meta-inf-in-code

18a761c

Use default JSdocProvider

9acd943

Implement utility function getMetaInformation

a21ccc6

Remove JayveeDocumentationProvider

8d7bc1a

Fix linter and test

7932bd9

Pull out function getAllBuiltinBlocktypes

4cd0a78

Update docs

2e64c22

Add missing license headers

e3caa48

georg-schwarz requested a review from rhazn September 26, 2023 13:32

georg-schwarz commented Oct 12, 2023

View reviewed changes

rhazn approved these changes Oct 12, 2023

View reviewed changes

georg-schwarz added 4 commits November 2, 2023 15:10

Remove info box from docs

48b883c

Ignore duplicates in getAllBuiltinBlocktypes

7d98ae4

Merge branch 'main' into block-meta-inf-in-code

b5bddfd

Adapt tests to changes

57ee14d

georg-schwarz force-pushed the block-meta-inf-in-code branch from 25a5cca to 57ee14d Compare November 2, 2023 15:02

georg-schwarz merged commit 84775e9 into main Nov 2, 2023
2 checks passed

georg-schwarz deleted the block-meta-inf-in-code branch November 2, 2023 15:11

github-actions bot locked and limited conversation to collaborators Nov 2, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactoring: Define Blocktypes solely in Code #445

Refactoring: Define Blocktypes solely in Code #445

georg-schwarz commented Sep 4, 2023 •

edited

Loading

georg-schwarz left a comment •

edited

Loading

georg-schwarz Sep 7, 2023

georg-schwarz Sep 26, 2023

georg-schwarz Sep 7, 2023

georg-schwarz Sep 7, 2023

georg-schwarz Oct 12, 2023

georg-schwarz Nov 2, 2023

georg-schwarz Oct 12, 2023

georg-schwarz Nov 2, 2023

rhazn left a comment

Refactoring: Define Blocktypes solely in Code #445

Refactoring: Define Blocktypes solely in Code #445

Conversation

georg-schwarz commented Sep 4, 2023 • edited Loading

Next steps

georg-schwarz left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rhazn left a comment

Choose a reason for hiding this comment

georg-schwarz commented Sep 4, 2023 •

edited

Loading

georg-schwarz left a comment •

edited

Loading