Add ParseFromReader function #3031
Conversation
ShubhamRasal
commented
Dec 13, 2022
ShubhamRasal
commented
- add parse function to read from the reader interface instead of filepath
v2/pkg/templates/compile.go
Outdated
|
|
||
| // ParseFromReader reads the template from reader | ||
| // returns the parsed template | ||
| func ParseFromReader(reader io.Reader, options protocols.ExecuterOptions) (*Template, error) { |
There was a problem hiding this comment.
Not sure if it's intentional, but I'd suggest refactoring the existing Parse(filePath string, preprocessor Preprocessor, options protocols.ExecuterOptions) to open the file in filePath and pass the reader to ParseFromReader. This will also ensure that the Variables block is evaluated through the Preprocessor.
There was a problem hiding this comment.
I agree, we should make Parse call ParseFromReader so as to reduce duplicate logic
v2/pkg/templates/compile.go
Outdated
| // ParseFromReader reads the template from reader | ||
| // returns the parsed template | ||
| func ParseFromReader(reader io.Reader, preprocessor Preprocessor, options protocols.ExecuterOptions) (*Template, error) { | ||
|
|
v2/pkg/templates/compile.go
Outdated
| func ParseFromReader(reader io.Reader, preprocessor Preprocessor, options protocols.ExecuterOptions) (*Template, error) { | ||
|
|
||
| template := &Template{} | ||
| data, err := ioutil.ReadAll(reader) |
| return nil, err | ||
| } | ||
|
|
||
| if utils.IsBlank(template.Info.Name) { |
There was a problem hiding this comment.
Shouldn't also this logic be in the new ParseFromReader since it performs additional checks and fills other fields that would be missed otherwise?
There was a problem hiding this comment.
yes.. it is already there in ParseFromReader function.
- update the ioutils to io.ReadAll - remove extra line
There was a problem hiding this comment.
I'd recommend to refactor in the following way:
ParseWithPathOrURL loads data from file/url and invoke Parse
..
func ParseWithPathOrURL(filePath string, preprocessor Preprocessor, options protocols.ExecuterOptions) (*Template, error) {
...
data, err := utils.ReadFromPathOrURL(filePath, options.Catalog)
if err != nil {
return nil, err
}
template, err := Parse(data, preprocessor, options)
if err != nil {
return nil, err
}
...ParseWithReader consumes the reader and invoke Parse
..
func ParseWithReader(reader io.Reader, preprocessor Preprocessor, options protocols.ExecuterOptions) (*Template, error) {
data, err := io.ReadAll(reader)
if err != nil {
return nil, err
}
return Parse(data, preprocessor, options)
}
...Parse performs the actual parsing on raw data
..
func Parse(data []byte, preprocessor Preprocessor, options protocols.ExecuterOptions) (*Template, error) {
template := &Template{}
...
}
...
