Skip to content

Commit

Permalink
Refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
@SupunS
SupunS committed Feb 13, 2024
1 parent ffba5e1 commit fadbc8d
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 28 deletions.
2 changes: 1 addition & 1 deletion runtime/interpreter/interpreter.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4614,7 +4614,7 @@ func (interpreter *Interpreter) AllElaborations() (elaborations map[common.Locat
// Ensure the program for this location is loaded,
// so its checker is available

for location, _ := range interpreter.SharedState.allInterpreters {
for location := range interpreter.SharedState.allInterpreters {

Check failure on line 4617 in runtime/interpreter/interpreter.go

View workflow job for this annotation

GitHub Actions / Lint 

range statement over map: map[github.com/onflow/cadence/runtime/common.Location]*github.com/onflow/cadence/runtime/interpreter.Interpreter (maprange)

Check failure on line 4617 in runtime/interpreter/interpreter.go

View workflow job for this annotation

GitHub Actions / Lint 

range statement over map: map[github.com/onflow/cadence/runtime/common.Location]*github.com/onflow/cadence/runtime/interpreter.Interpreter (maprange)
subInterpreter := interpreter.EnsureLoaded(location)
if subInterpreter == nil || subInterpreter.Program == nil {
return nil
Expand Down
2 changes: 1 addition & 1 deletion runtime/stdlib/account.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1620,7 +1620,7 @@ func changeAccountContracts(

var validator UpdateValidator
if legacyContractUpgrade {
validator = NewLegacyContractUpdateValidator(
validator = NewCadenceV042ToV1ContractUpdateValidator(
location,
contractName,
handler,
Expand Down
30 changes: 27 additions & 3 deletions ...egacy_contract_upgrade_validation_test.go → ...to_v1_contract_upgrade_validation_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ func testContractUpdate(t *testing.T, oldCode string, newCode string) error {
err = checker.Check()
require.NoError(t, err)

upgradeValidator := stdlib.NewLegacyContractUpdateValidator(
upgradeValidator := stdlib.NewCadenceV042ToV1ContractUpdateValidator(
utils.TestLocation,
"Test",
&runtime_utils.TestRuntimeInterface{},
Expand Down Expand Up @@ -108,7 +108,7 @@ func testContractUpdateWithImports(t *testing.T, oldCode, oldImport string, newC
err = checker.Check()
require.NoError(t, err)

upgradeValidator := stdlib.NewLegacyContractUpdateValidator(
upgradeValidator := stdlib.NewCadenceV042ToV1ContractUpdateValidator(
utils.TestLocation,
"Test",
&runtime_utils.TestRuntimeInterface{
Expand Down Expand Up @@ -217,7 +217,6 @@ func TestContractUpgradeFieldAccess(t *testing.T) {
`

err := testContractUpdate(t, oldCode, newCode)

require.NoError(t, err)
})

Expand All @@ -244,7 +243,32 @@ func TestContractUpgradeFieldAccess(t *testing.T) {
`

err := testContractUpdate(t, oldCode, newCode)
require.NoError(t, err)
})

t.Run("change field access to self", func(t *testing.T) {

t.Parallel()

const oldCode = `
pub contract Test {
pub var a: Int
init() {
self.a = 0
}
}
`

const newCode = `
access(all) contract Test {
access(self) var a: Int
init() {
self.a = 0
}
}
`

err := testContractUpdate(t, oldCode, newCode)
require.NoError(t, err)
})
}
Expand Down
46 changes: 23 additions & 23 deletions ...dlib/legacy_contract_upgrade_validator.go → ...v0.42_to_v1_contract_upgrade_validator.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import (
"github.com/onflow/cadence/runtime/sema"
)

type LegacyContractUpdateValidator struct {
type CadenceV042ToV1ContractUpdateValidator struct {
TypeComparator

newElaborations map[common.Location]*sema.Elaboration
Expand All @@ -37,41 +37,41 @@ type LegacyContractUpdateValidator struct {
underlyingUpdateValidator *ContractUpdateValidator
}

// NewContractUpdateValidator initializes and returns a validator, without performing any validation.
// NewCadenceV042ToV1ContractUpdateValidator initializes and returns a validator, without performing any validation.
// Invoke the `Validate()` method of the validator returned, to start validating the contract.
func NewLegacyContractUpdateValidator(
func NewCadenceV042ToV1ContractUpdateValidator(
location common.Location,
contractName string,
provider AccountContractNamesProvider,
oldProgram *ast.Program,
newProgram *ast.Program,
newElaborations map[common.Location]*sema.Elaboration,
) *LegacyContractUpdateValidator {
) *CadenceV042ToV1ContractUpdateValidator {

underlyingValidator := NewContractUpdateValidator(location, contractName, provider, oldProgram, newProgram)

return &LegacyContractUpdateValidator{
return &CadenceV042ToV1ContractUpdateValidator{
underlyingUpdateValidator: underlyingValidator,
newElaborations: newElaborations,
}
}

var _ UpdateValidator = &LegacyContractUpdateValidator{}
var _ UpdateValidator = &CadenceV042ToV1ContractUpdateValidator{}

func (validator *LegacyContractUpdateValidator) getCurrentDeclaration() ast.Declaration {
func (validator *CadenceV042ToV1ContractUpdateValidator) getCurrentDeclaration() ast.Declaration {
return validator.underlyingUpdateValidator.getCurrentDeclaration()
}

func (validator *LegacyContractUpdateValidator) setCurrentDeclaration(decl ast.Declaration) {
func (validator *CadenceV042ToV1ContractUpdateValidator) setCurrentDeclaration(decl ast.Declaration) {
validator.underlyingUpdateValidator.setCurrentDeclaration(decl)
}

func (validator *LegacyContractUpdateValidator) getAccountContractNames(address common.Address) ([]string, error) {
func (validator *CadenceV042ToV1ContractUpdateValidator) getAccountContractNames(address common.Address) ([]string, error) {
return validator.underlyingUpdateValidator.accountContractNamesProvider.GetAccountContractNames(address)
}

// Validate validates the contract update, and returns an error if it is an invalid update.
func (validator *LegacyContractUpdateValidator) Validate() error {
func (validator *CadenceV042ToV1ContractUpdateValidator) Validate() error {
underlyingValidator := validator.underlyingUpdateValidator

oldRootDecl := getRootDeclaration(validator, underlyingValidator.oldProgram)
Expand All @@ -97,11 +97,11 @@ func (validator *LegacyContractUpdateValidator) Validate() error {
return nil
}

func (validator *LegacyContractUpdateValidator) report(err error) {
func (validator *CadenceV042ToV1ContractUpdateValidator) report(err error) {
validator.underlyingUpdateValidator.report(err)
}

func (validator *LegacyContractUpdateValidator) idAndLocationOfQualifiedType(typ *ast.NominalType) (common.TypeID, common.Location) {
func (validator *CadenceV042ToV1ContractUpdateValidator) idAndLocationOfQualifiedType(typ *ast.NominalType) (common.TypeID, common.Location) {

qualifiedString := typ.String()

Expand Down Expand Up @@ -131,12 +131,12 @@ func (validator *LegacyContractUpdateValidator) idAndLocationOfQualifiedType(typ
return common.NewTypeIDFromQualifiedName(nil, location, qualifiedString), location
}

func (validator *LegacyContractUpdateValidator) getEntitlementType(entitlement *ast.NominalType) *sema.EntitlementType {
func (validator *CadenceV042ToV1ContractUpdateValidator) getEntitlementType(entitlement *ast.NominalType) *sema.EntitlementType {
typeID, location := validator.idAndLocationOfQualifiedType(entitlement)
return validator.newElaborations[location].EntitlementType(typeID)
}

func (validator *LegacyContractUpdateValidator) getEntitlementSetAccess(entitlementSet ast.EntitlementSet) sema.EntitlementSetAccess {
func (validator *CadenceV042ToV1ContractUpdateValidator) getEntitlementSetAccess(entitlementSet ast.EntitlementSet) sema.EntitlementSetAccess {
var entitlements []*sema.EntitlementType

for _, entitlement := range entitlementSet.Entitlements() {
Expand All @@ -151,24 +151,24 @@ func (validator *LegacyContractUpdateValidator) getEntitlementSetAccess(entitlem
return sema.NewEntitlementSetAccess(entitlements, entitlementSetKind)
}

func (validator *LegacyContractUpdateValidator) getCompositeType(composite *ast.NominalType) *sema.CompositeType {
func (validator *CadenceV042ToV1ContractUpdateValidator) getCompositeType(composite *ast.NominalType) *sema.CompositeType {
typeID, location := validator.idAndLocationOfQualifiedType(composite)
return validator.newElaborations[location].CompositeType(typeID)
}

func (validator *LegacyContractUpdateValidator) getInterfaceType(intf *ast.NominalType) *sema.InterfaceType {
func (validator *CadenceV042ToV1ContractUpdateValidator) getInterfaceType(intf *ast.NominalType) *sema.InterfaceType {
typeID, location := validator.idAndLocationOfQualifiedType(intf)
return validator.newElaborations[location].InterfaceType(typeID)
}

func (validator *LegacyContractUpdateValidator) getIntersectedInterfaces(intersection []*ast.NominalType) (intfs []*sema.InterfaceType) {
func (validator *CadenceV042ToV1ContractUpdateValidator) getIntersectedInterfaces(intersection []*ast.NominalType) (intfs []*sema.InterfaceType) {
for _, intf := range intersection {
intfs = append(intfs, validator.getInterfaceType(intf))
}
return
}

func (validator *LegacyContractUpdateValidator) requirePermitsAccess(
func (validator *CadenceV042ToV1ContractUpdateValidator) requirePermitsAccess(
expected sema.Access,
found sema.EntitlementSetAccess,
foundType ast.Type,
Expand All @@ -183,7 +183,7 @@ func (validator *LegacyContractUpdateValidator) requirePermitsAccess(
return nil
}

func (validator *LegacyContractUpdateValidator) expectedAuthorizationOfComposite(composite *ast.NominalType) sema.Access {
func (validator *CadenceV042ToV1ContractUpdateValidator) expectedAuthorizationOfComposite(composite *ast.NominalType) sema.Access {
// if this field is set, we are currently upgrading a formerly legacy restricted type into a reference to a composite
// in this case, the expected entitlements are based not on the underlying composite type,
// but instead the types previously in the restriction set
Expand All @@ -201,7 +201,7 @@ func (validator *LegacyContractUpdateValidator) expectedAuthorizationOfComposite
return sema.NewAccessFromEntitlementSet(supportedEntitlements, sema.Conjunction)
}

func (validator *LegacyContractUpdateValidator) expectedAuthorizationOfIntersection(intersectionTypes []*ast.NominalType) sema.Access {
func (validator *CadenceV042ToV1ContractUpdateValidator) expectedAuthorizationOfIntersection(intersectionTypes []*ast.NominalType) sema.Access {

// a reference to an intersection (or restricted) type is granted entitlements based on the intersected interfaces,
// ignoring the legacy restricted type, as an intersection type appearing in the new contract means it must have originally
Expand All @@ -217,7 +217,7 @@ func (validator *LegacyContractUpdateValidator) expectedAuthorizationOfIntersect
return sema.NewAccessFromEntitlementSet(supportedEntitlements, sema.Conjunction)
}

func (validator *LegacyContractUpdateValidator) checkEntitlementsUpgrade(
func (validator *CadenceV042ToV1ContractUpdateValidator) checkEntitlementsUpgrade(
oldType *ast.ReferenceType,
newType *ast.ReferenceType,
) error {
Expand All @@ -244,7 +244,7 @@ func (validator *LegacyContractUpdateValidator) checkEntitlementsUpgrade(
return nil
}

func (validator *LegacyContractUpdateValidator) checkTypeUpgradability(oldType ast.Type, newType ast.Type) error {
func (validator *CadenceV042ToV1ContractUpdateValidator) checkTypeUpgradability(oldType ast.Type, newType ast.Type) error {

switch oldType := oldType.(type) {
case *ast.OptionalType:
Expand Down Expand Up @@ -320,7 +320,7 @@ func (validator *LegacyContractUpdateValidator) checkTypeUpgradability(oldType a

}

func (validator *LegacyContractUpdateValidator) checkField(oldField *ast.FieldDeclaration, newField *ast.FieldDeclaration) {
func (validator *CadenceV042ToV1ContractUpdateValidator) checkField(oldField *ast.FieldDeclaration, newField *ast.FieldDeclaration) {
oldType := oldField.TypeAnnotation.Type
newType := newField.TypeAnnotation.Type

Expand Down

0 comments on commit fadbc8d

Please sign in to comment.