This repository has been archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #163 from vulcanize/vdb-929-storage-key-lookup-cle…
…anup (VDB-929) Minimize storage key lookup bespoke code
- Loading branch information
Showing
12 changed files
with
412 additions
and
98 deletions.
There are no files selected for viewing
This file contains 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 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,28 @@ | ||
| // VulcanizeDB | ||
| // Copyright © 2019 Vulcanize | ||
|
|
||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
|
|
||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
|
|
||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package storage | ||
|
|
||
| import ( | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/vulcanize/vulcanizedb/libraries/shared/storage/utils" | ||
| "github.com/vulcanize/vulcanizedb/pkg/datastore/postgres" | ||
| ) | ||
|
|
||
| type KeysLoader interface { | ||
| LoadMappings() (map[common.Hash]utils.StorageValueMetadata, error) | ||
| SetDB(db *postgres.DB) | ||
| } |
This file contains 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,66 @@ | ||
| // VulcanizeDB | ||
| // Copyright © 2019 Vulcanize | ||
|
|
||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
|
|
||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
|
|
||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package storage | ||
|
|
||
| import ( | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/vulcanize/vulcanizedb/libraries/shared/storage/utils" | ||
| "github.com/vulcanize/vulcanizedb/pkg/datastore/postgres" | ||
| ) | ||
|
|
||
| type KeysLookup interface { | ||
| Lookup(key common.Hash) (utils.StorageValueMetadata, error) | ||
| SetDB(db *postgres.DB) | ||
| } | ||
|
|
||
| type keysLookup struct { | ||
| loader KeysLoader | ||
| mappings map[common.Hash]utils.StorageValueMetadata | ||
| } | ||
|
|
||
| func NewKeysLookup(loader KeysLoader) KeysLookup { | ||
| return &keysLookup{loader: loader, mappings: make(map[common.Hash]utils.StorageValueMetadata)} | ||
| } | ||
|
|
||
| func (lookup *keysLookup) Lookup(key common.Hash) (utils.StorageValueMetadata, error) { | ||
| metadata, ok := lookup.mappings[key] | ||
| if !ok { | ||
| refreshErr := lookup.refreshMappings() | ||
| if refreshErr != nil { | ||
| return metadata, refreshErr | ||
| } | ||
| metadata, ok = lookup.mappings[key] | ||
| if !ok { | ||
| return metadata, utils.ErrStorageKeyNotFound{Key: key.Hex()} | ||
| } | ||
| } | ||
| return metadata, nil | ||
| } | ||
|
|
||
| func (lookup *keysLookup) refreshMappings() error { | ||
| var err error | ||
| lookup.mappings, err = lookup.loader.LoadMappings() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| lookup.mappings = utils.AddHashedKeys(lookup.mappings) | ||
| return nil | ||
| } | ||
|
|
||
| func (lookup *keysLookup) SetDB(db *postgres.DB) { | ||
| lookup.loader.SetDB(db) | ||
| } |
This file contains 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,113 @@ | ||
| // VulcanizeDB | ||
| // Copyright © 2019 Vulcanize | ||
|
|
||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
|
|
||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
|
|
||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package storage_test | ||
|
|
||
| import ( | ||
| "github.com/ethereum/go-ethereum/common" | ||
| "github.com/ethereum/go-ethereum/crypto" | ||
| . "github.com/onsi/ginkgo" | ||
| . "github.com/onsi/gomega" | ||
| "github.com/vulcanize/vulcanizedb/libraries/shared/factories/storage" | ||
| "github.com/vulcanize/vulcanizedb/libraries/shared/mocks" | ||
| "github.com/vulcanize/vulcanizedb/libraries/shared/storage/utils" | ||
| "github.com/vulcanize/vulcanizedb/pkg/fakes" | ||
| "github.com/vulcanize/vulcanizedb/test_config" | ||
| ) | ||
|
|
||
| var _ = Describe("Storage keys lookup", func() { | ||
| var ( | ||
| fakeMetadata = utils.GetStorageValueMetadata("name", map[utils.Key]string{}, utils.Uint256) | ||
| lookup storage.KeysLookup | ||
| loader *mocks.MockStorageKeysLoader | ||
| ) | ||
|
|
||
| BeforeEach(func() { | ||
| loader = &mocks.MockStorageKeysLoader{} | ||
| lookup = storage.NewKeysLookup(loader) | ||
| }) | ||
|
|
||
| Describe("Lookup", func() { | ||
| Describe("when key not found", func() { | ||
| It("refreshes keys", func() { | ||
| loader.StorageKeyMappings = map[common.Hash]utils.StorageValueMetadata{fakes.FakeHash: fakeMetadata} | ||
| _, err := lookup.Lookup(fakes.FakeHash) | ||
|
|
||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(loader.LoadMappingsCallCount).To(Equal(1)) | ||
| }) | ||
|
|
||
| It("returns error if refreshing keys fails", func() { | ||
| loader.LoadMappingsError = fakes.FakeError | ||
|
|
||
| _, err := lookup.Lookup(fakes.FakeHash) | ||
|
|
||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err).To(MatchError(fakes.FakeError)) | ||
| }) | ||
| }) | ||
|
|
||
| Describe("when key found", func() { | ||
| BeforeEach(func() { | ||
| loader.StorageKeyMappings = map[common.Hash]utils.StorageValueMetadata{fakes.FakeHash: fakeMetadata} | ||
| _, err := lookup.Lookup(fakes.FakeHash) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(loader.LoadMappingsCallCount).To(Equal(1)) | ||
| }) | ||
|
|
||
| It("does not refresh keys", func() { | ||
| _, err := lookup.Lookup(fakes.FakeHash) | ||
|
|
||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(loader.LoadMappingsCallCount).To(Equal(1)) | ||
| }) | ||
| }) | ||
|
|
||
| It("returns metadata for loaded static key", func() { | ||
| loader.StorageKeyMappings = map[common.Hash]utils.StorageValueMetadata{fakes.FakeHash: fakeMetadata} | ||
|
|
||
| metadata, err := lookup.Lookup(fakes.FakeHash) | ||
|
|
||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(metadata).To(Equal(fakeMetadata)) | ||
| }) | ||
|
|
||
| It("returns metadata for hashed version of key (accommodates keys emitted from Geth)", func() { | ||
| loader.StorageKeyMappings = map[common.Hash]utils.StorageValueMetadata{fakes.FakeHash: fakeMetadata} | ||
|
|
||
| hashedKey := common.BytesToHash(crypto.Keccak256(fakes.FakeHash.Bytes())) | ||
| metadata, err := lookup.Lookup(hashedKey) | ||
|
|
||
| Expect(err).NotTo(HaveOccurred()) | ||
| Expect(metadata).To(Equal(fakeMetadata)) | ||
| }) | ||
|
|
||
| It("returns key not found error if key not found", func() { | ||
| _, err := lookup.Lookup(fakes.FakeHash) | ||
|
|
||
| Expect(err).To(HaveOccurred()) | ||
| Expect(err).To(MatchError(utils.ErrStorageKeyNotFound{Key: fakes.FakeHash.Hex()})) | ||
| }) | ||
| }) | ||
|
|
||
| Describe("SetDB", func() { | ||
| It("sets the db on the loader", func() { | ||
| lookup.SetDB(test_config.NewTestDB(test_config.NewTestNode())) | ||
|
|
||
| Expect(loader.SetDBCalled).To(BeTrue()) | ||
| }) | ||
| }) | ||
| }) |
This file contains 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 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
Oops, something went wrong.