(GH-24) Allow parsing in tasks mode #93

glennsarti · 2019-01-18T08:12:56Z

The Puppet language introduced Puppet Tasks and Plans as part of
Puppet 5.4.0 [1]. A special parsing switch --tasks was
introduced which changes the behaviour of the Puppet parser, that
is switching it into "tasks" mode. Unfortunately this switch is
global to all Puppet parsing therefore to dynamically switch it
like we do in Editor Services, this required a global mutex to be
used.

Note that this commit does not add Puppet Tasks/Plans intellisense
but merely allows the standard manifest providers (completion,
validation etc.) to actually function instead of silently failing

This commit;

Modifies the Puppet parser, via monkey patching, to implement a
"singleton" parsing method that dynamically, and safely, switch
the parsing mode on a per request basis
Modifies the Document Store to detect whether a File URI is a
Puppet Task/Plan based on the relative path of the file versus
the module root.
Modifies the various providers to call the parsing helper in the
correct mode
Modifies the Message Router to detect whether a file is a Puppet
Task/Plan and then sets the appropriate mode when calling the
manifest providers (completion, validation etc.)

[1] https://puppet.com/docs/bolt/1.x/writing_plans.html#concept-4485

Fixes #24

Extend parsing to dynamically switch Puppet[:tasks]
Add tests for parsing plan files

Completion Provider

Extend manifest completion provider to understand plan files
Add tests for completing plan files

Definition Provider

Extend manifest definition provider to understand plan files
Add tests for defining plan files

Document Symbol Provider

Extend manifest doc. symbol provider to understand plan files
Add tests for symbol-extracting plan files

Hover Provider

Extend manifest hover provider to understand plan files
Add tests for hovering in plan files

Validation Provider

modify Validation parsing to dynamically switch Puppet[:tasks]
Extend validation provider to understand plan files
Add tests for validating plan files

glennsarti · 2019-01-20T03:38:56Z

Extracting and using the bolt metadata may be another PR. The scope is creepin'

Previously the parser helper was silently failing to parse documents that had the cursor at line 0, char 0. This was due to the removal based methods trying to remove characters at the beginning of the document. This commit modifies the helper to ignore these parsing attempts if the cursor is at line 0, char 0.

jpogran · 2019-01-24T18:30:39Z

With the puppetlabs-reboot module I still get a syntax error:

Environment:

VSCode:

[master ≡ +0 ~1 -0 !] ~\src\lingua-pupuli\vscode
01-24 18:39:27 21> code -v
1.30.2
61122f88f0bf01e2ac16bdb9e1bc4571755f5bd8
x64

Puppet: v6.0.2 from PDK 1.7.1

Repro steps:

Set editor-compontents.json

[master ≡ +0 ~1 -0 !] ~\src\lingua-pupuli\vscode
01-24 18:35:25 16> git diff
diff --git a/editor-components.json b/editor-components.json
index 013dbfe..c3c0b19 100644
--- a/editor-components.json
+++ b/editor-components.json
@@ -1,6 +1,8 @@
 {
   "editor-services": {
-    "release": "0.17.0"
+    "githubuser": "glennsarti",
+    "githubrepo": "puppet-editor-services",
+    "githubref": "gh-24-parseplans"
   },
   "editor-syntax": {
     "release": "1.3.0"

Pull latest

master ≡ +0 ~1 -0 !] ~\src\lingua-pupuli\vscode
01-24 18:35:29 17> npm run vscode:prepublish

> puppet-vscode@0.15.1 vscode:prepublish C:\Users\james\src\lingua-pupuli\vscode
> node node_modules/gulp/bin/gulp.js build

[18:36:55] Using gulpfile ~\src\lingua-pupuli\vscode\gulpfile.js
[18:36:55] Starting 'build'...
[18:36:55] Starting 'clean'...
[18:36:55] Finished 'clean' after 118 ms
[18:36:55] Starting 'vendor'...
[18:36:55] Starting 'vendor_editor_services'...
[18:36:57] Finished 'vendor_editor_services' after 1.11 s
[18:36:57] Starting 'vendor_editor_syntax'...
[18:36:57] Finished 'vendor_editor_syntax' after 251 ms
[18:36:57] Finished 'vendor' after 1.37 s
[18:36:57] Starting 'compile_typescript'...
[18:36:59] Finished 'compile_typescript' after 2.65 s
[18:36:59] Finished 'build' after 4.15 s

Launch Extension Debug host with puppetlabs-reboot

glennsarti · 2019-01-25T00:51:47Z

Repro'd. Try to figure out what's gone south ...

glennsarti · 2019-01-25T01:23:46Z

Found it...URI escaping was breaking my path checking.

glennsarti · 2019-01-25T05:32:09Z

Fixed. Had to rework the URIHelper.

.... and CI blew up :-)

The Puppet language introduced Puppet Tasks and Plans as part of Puppet 5.4.0 [1]. A special parsing switch `--tasks` was introduced which changes the behaviour of the Puppet parser, that is switching it into "tasks" mode. Unfortunately this switch is global to all Puppet parsing therefore to dynamically switch it like we do in Editor Services, this required a global mutex to be used. Note that this commit does not add Puppet Tasks/Plans intellisense but merely allows the standard manifest providers (completion, validation etc.) to actually function instead of silently failing This commit; * Modifies the Puppet parser, via monkey patching, to implement a "singleton" parsing method that dynamically, and safely, switch the parsing mode on a per request basis * Modifies the Document Store to detect whether a File URI is a Puppet Task/Plan based on the relative path of the file versus the module root. * Modifies the various providers to call the parsing helper in the correct mode * Modifies the Message Router to detect whether a file is a Puppet Task/Plan and then sets the appropriate mode when calling the manifest providers (completion, validation etc.) [1] https://puppet.com/docs/bolt/1.x/writing_plans.html#concept-4485

This commit updates two minor violations that appeared as part of robocop 0.63.1.

jpogran · 2019-01-25T16:10:47Z

Confirmed working with previous setup:

jpogran · 2019-01-25T16:11:47Z

We'll have to add documentation in the vscode readme about what to expect. For example, we no longer throw errors, but the advanced features are not implemented yet. WIP, etc

glennsarti force-pushed the gh-24-parseplans branch from 19cdcd2 to d71fe76 Compare January 20, 2019 04:33

glennsarti changed the title ~~{WIP} (GH_24) Allow parsing in tasks mode~~ {WIP} (GH-24) Allow parsing in tasks mode Jan 20, 2019

glennsarti force-pushed the gh-24-parseplans branch from 16bfea4 to 7f7138c Compare January 20, 2019 06:21

glennsarti force-pushed the gh-24-parseplans branch from 7f7138c to 054eef4 Compare January 20, 2019 12:46

glennsarti added this to the 0.18.0 milestone Jan 20, 2019

glennsarti force-pushed the gh-24-parseplans branch from d0cbe2d to 08ed9ba Compare January 21, 2019 09:06

glennsarti changed the title ~~{WIP} (GH-24) Allow parsing in tasks mode~~ (GH-24) Allow parsing in tasks mode Jan 21, 2019

glennsarti added enhancement New feature or request Language Server labels Jan 21, 2019

jpogran assigned glennsarti Jan 24, 2019

jpogran self-requested a review January 24, 2019 15:09

glennsarti force-pushed the gh-24-parseplans branch from 08ed9ba to b86ce67 Compare January 25, 2019 04:23

glennsarti added 2 commits January 25, 2019 13:45

(maint) Update for rubocop 0.63.1

06c8b01

This commit updates two minor violations that appeared as part of robocop 0.63.1.

glennsarti force-pushed the gh-24-parseplans branch from b86ce67 to 06c8b01 Compare January 25, 2019 05:48

jpogran approved these changes Jan 25, 2019

View reviewed changes

jpogran merged commit 99fce1d into puppetlabs:master Jan 25, 2019

jpogran mentioned this pull request Jan 25, 2019

Document current bolt tasks/plans support puppetlabs/puppet-vscode#472

Closed

glennsarti deleted the gh-24-parseplans branch February 8, 2019 02:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

(GH-24) Allow parsing in tasks mode #93

(GH-24) Allow parsing in tasks mode #93

Uh oh!

glennsarti commented Jan 18, 2019 •

edited

Loading

Uh oh!

glennsarti commented Jan 20, 2019 •

edited

Loading

Uh oh!

jpogran commented Jan 24, 2019 •

edited

Loading

Uh oh!

glennsarti commented Jan 25, 2019

Uh oh!

glennsarti commented Jan 25, 2019

Uh oh!

glennsarti commented Jan 25, 2019 •

edited

Loading

Uh oh!

jpogran commented Jan 25, 2019

Uh oh!

jpogran commented Jan 25, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

(GH-24) Allow parsing in tasks mode #93

(GH-24) Allow parsing in tasks mode #93

Uh oh!

Conversation

glennsarti commented Jan 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Completion Provider

Definition Provider

Document Symbol Provider

Hover Provider

Validation Provider

Uh oh!

glennsarti commented Jan 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jpogran commented Jan 24, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

glennsarti commented Jan 25, 2019

Uh oh!

glennsarti commented Jan 25, 2019

Uh oh!

glennsarti commented Jan 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jpogran commented Jan 25, 2019

Uh oh!

jpogran commented Jan 25, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

glennsarti commented Jan 18, 2019 •

edited

Loading

glennsarti commented Jan 20, 2019 •

edited

Loading

jpogran commented Jan 24, 2019 •

edited

Loading

glennsarti commented Jan 25, 2019 •

edited

Loading