feat: add support for pkl files #331
+195
−5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| package validator | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "os/exec" | ||
|
|
||
| "github.com/apple/pkl-go/pkl" | ||
| ) | ||
|
|
||
| var ( | ||
| // ErrPklSkipped is returned when a validation is skipped due to a missing dependency. | ||
| ErrPklSkipped = errors.New("validation skipped") | ||
| ) | ||
|
Check failure on line 15 in pkg/validator/pkl.go
|
||
| // PklValidator is used to validate a byte slice that is intended to represent a | ||
| // PKL file. | ||
| type PklValidator struct { | ||
| evaluatorFactory func(context.Context, ...func(*pkl.EvaluatorOptions)) (pkl.Evaluator, error) | ||
| } | ||
|
|
||
| // Validate attempts to evaluate the provided byte slice as a PKL file. | ||
| // If the 'pkl' binary is not found, it returns ErrSkipped. | ||
| func (v PklValidator) Validate(b []byte) (bool, error) { | ||
| ctx := context.Background() | ||
|
|
||
| // Convert the byte slice to a ModuleSource using TextSource | ||
| source := pkl.TextSource(string(b)) | ||
|
|
||
| evaluatorFactory := v.evaluatorFactory | ||
| if evaluatorFactory == nil { | ||
| evaluatorFactory = pkl.NewEvaluator | ||
| } | ||
|
|
||
| evaluator, err := evaluatorFactory(ctx, pkl.PreconfiguredOptions) | ||
| if err != nil { | ||
| // If the error is that the pkl binary was not found, return ErrPklSkipped. | ||
| var execErr *exec.Error | ||
| if errors.As(err, &execErr) && execErr.Err == exec.ErrNotFound { | ||
|
Check failure on line 39 in pkg/validator/pkl.go
|
||
| return false, ErrPklSkipped | ||
| } | ||
| return false, fmt.Errorf("failed to create evaluator: %w", err) | ||
| } | ||
|
|
||
| _, err = evaluator.EvaluateExpressionRaw(ctx, source, "") | ||
| if err != nil { | ||
| return false, fmt.Errorf("failed to evaluate module: %w", err) | ||
| } | ||
|
|
||
| return true, nil | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
|
|
||
|
|
||
| name = "PhoenixWebApp" | ||
|
|
||
| package { | ||
| name = "phoenix" | ||
| version = "2.1.0" | ||
| authors = List("Phoenix Engineering <[email protected]>") | ||
| } | ||
|
|
||
| database { | ||
| host = "db.phoenix.internal" | ||
| port = 5432 | ||
| username = "phoenix_user" | ||
| poolSize = 20 | ||
| sslMode = "require" | ||
| } | ||
|
|
||
| server { | ||
| host = "0.0.0.0" | ||
| port = 8080 | ||
| logLevel = "info" // "debug", "info", "warn", "error" | ||
| corsOrigins = List("https://phoenix.example", "https://app.phoenix.example") | ||
| } | ||
|
|
||
| features { | ||
| newSignupFlow = true | ||
| apiRateLimiting = true | ||
| dashboardAnalytics = false | ||
| } | ||
|
|
||
| // --- Service Replica Configuration --- | ||
| local class Replica { | ||
| region: "us-east-1" | "us-west-2" | "eu-central-1" | ||
| instanceType: String | ||
| count: Int | ||
| } | ||
|
|
||
| replicas = List( | ||
| new Replica { | ||
| region = "us-east-1" | ||
| instanceType = "t3.medium" | ||
| count = 3 | ||
| }, | ||
| new Replica { | ||
| region = "us-west-2" | ||
| instanceType = "t3.medium" | ||
| count = 2 | ||
| } | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| "invalid" |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The unit tests shouldn't rely on PKL being present - that should be mocked so the tests are deterministic
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok we can do this. But I'll have to extract out the pkl tests to their own function, deviating from the existing pattern of putting tuples in the testData array
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fine - it's the first time we have to rely on the presence of a local binary
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akhil-rasheed Looking at the PKL Go documentation, I do not think the binary is required anymore. The PKL binary is only required when using code generation and it looks like you can load PKL into a struct without using Code Generation: https://pkl-lang.org/go/current/evaluation.html#without-code-generation. This may only apply to a pre-defined struct though which wouldn't work.
Please take a look and see if this is a viable path. This would greatly simplify the implementation.