Updates Class and TypeAlias representation according to SPICE-0021

Author: HT154

pkl/decode_struct.go

@@ -270,13 +270,37 @@ func (d *decoder) decodeStructField(fields map[string]structField, out *reflect.
 	return d.skip(length - 3)
 }
 
-func (d *decoder) decodeClass() (*reflect.Value, error) {
-	ret := reflect.ValueOf(Class{})
+func (d *decoder) decodeClass(length int) (*reflect.Value, error) {
+	var (
+		class Class
+		err   error
+	)
+	if length > 1 { // pkl 0.30+ includes the qualified name and module uri
+		if class.ModuleUri, err = d.dec.DecodeString(); err != nil {
+			return nil, err
+		}
+		if class.QualifiedName, err = d.dec.DecodeString(); err != nil {
+			return nil, err
+		}
+	}
+	ret := reflect.ValueOf(class)
 	return &ret, nil
 }
 
-func (d *decoder) decodeTypeAlias() (*reflect.Value, error) {
-	ret := reflect.ValueOf(TypeAlias{})
+func (d *decoder) decodeTypeAlias(length int) (*reflect.Value, error) {
+	var (
+		typeAlias TypeAlias
+		err       error
+	)
+	if length > 1 { // pkl 0.30+ includes the qualified name and module uri
+		if typeAlias.ModuleUri, err = d.dec.DecodeString(); err != nil {
+			return nil, err
+		}
+		if typeAlias.QualifiedName, err = d.dec.DecodeString(); err != nil {
+			return nil, err
+		}
+	}
+	ret := reflect.ValueOf(typeAlias)
 	return &ret, nil
 }
 

pkl/decoder.go

@@ -66,8 +66,8 @@ var durationType = reflect.TypeOf(time.Duration(0))
 
 // Decode decodes the next value according to the expected type.
 func (d *decoder) Decode(typ reflect.Type) (res *reflect.Value, err error) {
-	res, isUnmarshaled, err := d.maybeUnmarshal(typ)
-	if isUnmarshaled {
+	res, isUnmarshalled, err := d.maybeUnmarshal(typ)
+	if isUnmarshalled {
 		return res, err
 	}
 	switch typ.Kind() {
@@ -145,7 +145,7 @@ func (d *decoder) decodePointer(inType reflect.Type) (*reflect.Value, error) {
 }
 
 // maybeUnmarshal determines if typ implements encoding.BinaryUnmarshaler, and if it does,
-// performs the unmarshaling.
+// performs the unmarshalling.
 func (d *decoder) maybeUnmarshal(typ reflect.Type) (*reflect.Value, bool, error) {
 	ptr := reflect.New(typ)
 	unmarshaler, isUnmarshaler := ptr.Interface().(encoding.BinaryUnmarshaler)
@@ -231,9 +231,9 @@ func (d *decoder) decodePklObject(typ reflect.Type, requireStruct bool) (res *re
 	case code == codeRegex:
 		res, err = d.decodeRegex()
 	case code == codeClass:
-		res, err = d.decodeClass()
+		res, err = d.decodeClass(length)
 	case code == codeTypeAlias:
-		res, err = d.decodeTypeAlias()
+		res, err = d.decodeTypeAlias(length)
 	default:
 		if requireStruct {
 			return nil, fmt.Errorf("code %#02x cannot be decoded into a struct", code)
@@ -246,7 +246,7 @@ func (d *decoder) decodePklObject(typ reflect.Type, requireStruct bool) (res *re
 	if err != nil {
 		return nil, err
 	}
-	return res, d.skip(length - getDecodedLength(code) - 1) // -1 is from the code field
+	return res, d.skip(length - getDecodedLength(code, length) - 1) // -1 is from the code field
 }
 
 // decodeObjectPreamble decodes the preamble for Pkl objects.
@@ -266,7 +266,7 @@ func (d *decoder) decodeObjectPreamble() (int, int, error) {
 }
 
 // getDecodedLength returns the number of array fields a specific type code is expected to yield
-func getDecodedLength(code int) int {
+func getDecodedLength(code, length int) int {
 	switch code {
 	case codeObject:
 		return 3 // name, moduleUri, member array
@@ -277,6 +277,11 @@ func getDecodedLength(code int) int {
 	case codeIntSeq:
 		return 3 // start, end, step
 	case codeClass, codeTypeAlias:
+		if length > 1 {
+			// pkl 0.30+ includes the qualified name and module uri
+			return 2
+		}
+		// before pkl 0.30 only the type code is present
 		return 0
 	default:
 		return 1

pkl/evaluator_manager.go

@@ -23,6 +23,7 @@ import (
 	"net/url"
 	"sync"
 
+	"github.com/apple/pkl-go/pkl/internal"
 	"github.com/apple/pkl-go/pkl/internal/msgapi"
 )
 
@@ -78,7 +79,7 @@ type evaluatorManagerImpl interface {
 	inChan() chan msgapi.IncomingMessage
 	outChan() chan msgapi.OutgoingMessage
 	closedChan() chan error
-	getVersion() (*semver, error)
+	getVersion() (*internal.Semver, error)
 }
 
 var _ EvaluatorManager = (*evaluatorManager)(nil)
@@ -159,7 +160,7 @@ func (m *evaluatorManager) NewProjectEvaluator(ctx context.Context, projectBaseU
 	return NewEvaluator(ctx, newOpts...)
 }
 
-func (m *evaluatorManager) getVersion() (*semver, error) {
+func (m *evaluatorManager) getVersion() (*internal.Semver, error) {
 	return m.impl.getVersion()
 }
 

pkl/evaluator_manager_exec.go

@@ -69,7 +69,7 @@ type execEvaluator struct {
 	closed chan error
 	// exited is a flag that indicates evaluator was closed explicitly
 	exited      atomicBool
-	version     *semver
+	version     *internal.Semver
 	pklCommand  []string
 	processDone chan struct{}
 }
@@ -86,9 +86,9 @@ func (e *execEvaluator) closedChan() chan error {
 	return e.closed
 }
 
-var pklVersionRegex = regexp.MustCompile(fmt.Sprintf("Pkl (%s).*", semverPattern.String()))
+var pklVersionRegex = regexp.MustCompile(fmt.Sprintf("Pkl (%s).*", internal.SemverPattern.String()))
 
-func (e *execEvaluator) getVersion() (*semver, error) {
+func (e *execEvaluator) getVersion() (*internal.Semver, error) {
 	if e.version != nil {
 		return e.version, nil
 	}
@@ -102,7 +102,7 @@ func (e *execEvaluator) getVersion() (*semver, error) {
 	if len(matches) < 2 {
 		return nil, fmt.Errorf("failed to get version information from Pkl. Ran `%s`, and got stdout \"%s\"", strings.Join(command.Args, " "), versionCmdOut)
 	}
-	version, err := parseSemver(matches[1])
+	version, err := internal.ParseSemver(matches[1])
 	if err != nil {
 		return nil, err
 	}

pkl/evaluator_manager_test.go

@@ -22,6 +22,7 @@ import (
 	"sync"
 	"testing"
 
+	"github.com/apple/pkl-go/pkl/internal"
 	"github.com/apple/pkl-go/pkl/internal/msgapi"
 	"github.com/stretchr/testify/assert"
 )
@@ -33,11 +34,11 @@ type fakeEvaluatorImpl struct {
 	closed  chan error
 }
 
-func (f *fakeEvaluatorImpl) getVersion() (*semver, error) {
+func (f *fakeEvaluatorImpl) getVersion() (*internal.Semver, error) {
 	if f.version == "" {
-		return pklVersion0_25, nil
+		return internal.PklVersion0_25, nil
 	}
-	return parseSemver(f.version)
+	return internal.ParseSemver(f.version)
 }
 
 func (f *fakeEvaluatorImpl) init() error {
@@ -62,7 +63,7 @@ func (f *fakeEvaluatorImpl) closedChan() chan error {
 
 var _ evaluatorManagerImpl = (*fakeEvaluatorImpl)(nil)
 
-func newFakeEvalautorManager() *evaluatorManager {
+func newFakeEvaluatorManager() *evaluatorManager {
 	return &evaluatorManager{
 		impl: &fakeEvaluatorImpl{
 			in:     make(chan msgapi.IncomingMessage),
@@ -76,7 +77,7 @@ func newFakeEvalautorManager() *evaluatorManager {
 }
 
 func TestEvaluatorManager_interrupt_NewEvaluator(t *testing.T) {
-	m := newFakeEvalautorManager()
+	m := newFakeEvaluatorManager()
 	defer assert.NoError(t, m.Close())
 	go m.listen()
 	go func() {
@@ -88,7 +89,7 @@ func TestEvaluatorManager_interrupt_NewEvaluator(t *testing.T) {
 }
 
 func TestEvaluatorManager_interrupt_Close(t *testing.T) {
-	m := newFakeEvalautorManager()
+	m := newFakeEvaluatorManager()
 	go m.listen()
 	go func() {
 		_ = m.Close()

pkl/evaluator_options.go

@@ -23,6 +23,7 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/apple/pkl-go/pkl/internal"
 	"github.com/apple/pkl-go/pkl/internal/msgapi"
 )
 
@@ -55,6 +56,7 @@ type EvaluatorOptions struct {
 	//   - `"textproto"`
 	//   - `"xml"`
 	//   - `"yaml"`
+	//   - `"pkl-binary"`
 	OutputFormat string
 
 	// AllowedModules defines URI patterns that determine which modules are permitted to be loaded and evaluated.
@@ -77,7 +79,7 @@ type EvaluatorOptions struct {
 
 	// CacheDir is the directory where `package:` modules are cached.
 	//
-	// If empty, no cacheing is performed.
+	// If empty, no caching is performed.
 	CacheDir string
 
 	// RootDir is the root directory for file-based reads within a Pkl program.
@@ -106,7 +108,7 @@ type EvaluatorOptions struct {
 	// or EvaluatorManager.NewProjectEvaluator.
 	ProjectBaseURI string
 
-	// DeclaredProjectDepenedencies is set of dependencies available to modules within ProjectBaseURI.
+	// DeclaredProjectDependencies is set of dependencies available to modules within ProjectBaseURI.
 	//
 	// When importing dependencies, a PklProject.deps.json file must exist within ProjectBaseURI
 	// that contains the project's resolved dependencies.
@@ -337,17 +339,17 @@ var WithOsEnv = func(opts *EvaluatorOptions) {
 	}
 }
 
-func buildEvaluatorOptions(version *semver, fns ...func(*EvaluatorOptions)) (*EvaluatorOptions, error) {
+func buildEvaluatorOptions(version *internal.Semver, fns ...func(*EvaluatorOptions)) (*EvaluatorOptions, error) {
 	o := &EvaluatorOptions{}
 	for _, f := range fns {
 		f(o)
 	}
 	// repl:text is the URI of the module used to hold expressions. It should always be allowed.
 	o.AllowedModules = append(o.AllowedModules, "repl:text")
-	if o.Http != nil && pklVersion0_26.isGreaterThan(version) {
+	if o.Http != nil && internal.PklVersion0_26.IsGreaterThan(version) {
 		return nil, fmt.Errorf("http options are not supported on Pkl versions lower than 0.26")
 	}
-	if (len(o.ExternalModuleReaders) > 0 || len(o.ExternalResourceReaders) > 0) && pklVersion0_27.isGreaterThan(version) {
+	if (len(o.ExternalModuleReaders) > 0 || len(o.ExternalResourceReaders) > 0) && internal.PklVersion0_27.IsGreaterThan(version) {
 		return nil, fmt.Errorf("external reader options are not supported on Pkl versions lower than 0.27")
 	}
 	return o, nil

pkl/evaluator_test.go

@@ -29,6 +29,7 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/apple/pkl-go/pkl/internal"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -120,7 +121,7 @@ func TestEvaluator(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
-		if version.isLessThan(pklVersion0_29) {
+		if version.IsLessThan(internal.PklVersion0_29) {
 			t.SkipNow()
 		}
 		ev, err := manager.NewEvaluator(context.Background(), PreconfiguredOptions)
@@ -155,7 +156,7 @@ func TestEvaluator(t *testing.T) {
 		if err != nil {
 			t.Fatal(err)
 		}
-		if version.isLessThan(pklVersion0_29) {
+		if version.IsLessThan(internal.PklVersion0_29) {
 			t.SkipNow()
 		}
 		ev, err := manager.NewEvaluator(context.Background(), PreconfiguredOptions)
@@ -584,7 +585,7 @@ class Bar {
 		if err != nil {
 			t.Fatal(err)
 		}
-		if pklVersion0_26.isGreaterThan(version) {
+		if internal.PklVersion0_26.IsGreaterThan(version) {
 			t.SkipNow()
 		}
 		ev, err := manager.NewEvaluator(context.Background(), PreconfiguredOptions, func(options *EvaluatorOptions) {
@@ -606,7 +607,7 @@ class Bar {
 		if err != nil {
 			t.Fatal(err)
 		}
-		if version.isGreaterThan(pklVersion0_25) {
+		if version.IsGreaterThan(internal.PklVersion0_25) {
 			t.SkipNow()
 		}
 		_, err = manager.NewEvaluator(context.Background(), PreconfiguredOptions, func(options *EvaluatorOptions) {

pkl/external_reader_test.go

@@ -22,6 +22,7 @@ import (
 	"runtime"
 	"testing"
 
+	"github.com/apple/pkl-go/pkl/internal"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -44,7 +45,7 @@ func TestExternalReaderE2E(t *testing.T) {
 	if err != nil {
 		t.Fatal(err)
 	}
-	if pklVersion0_27.isGreaterThan(version) {
+	if internal.PklVersion0_27.IsGreaterThan(version) {
 		t.SkipNow()
 	}