@openzeppelin/upgrades-core 1.22.0 → 1.24.0

package/src/storage/report-gap.test.ts

@@ -24,6 +24,19 @@ const testContracts = [
   'contracts/test/Storage.sol:StorageUpgrade_Gap_V2_Bad5',
   'contracts/test/Storage.sol:StorageUpgrade_MultiConsumeGap_V1',
   'contracts/test/Storage.sol:StorageUpgrade_MultiConsumeGap_V2_Ok',
+  'contracts/test/Storage.sol:StorageUpgrade_CustomGap_V1',
+  'contracts/test/Storage.sol:StorageUpgrade_CustomGap_V2_Ok',
+  'contracts/test/Storage.sol:StorageUpgrade_CustomGap_V2_Bad',
+  'contracts/test/Storage.sol:StorageUpgrade_CustomGap_V2_Bad2',
+  'contracts/test/Storage.sol:StorageUpgrade_CustomGap_V2_Ok_Switched_Gaps',
+  'contracts/test/Storage.sol:StorageUpgrade_CustomGap_V2_Bad_Switched_Gaps',
+  'contracts/test/Storage.sol:StorageUpgrade_CustomGap_V2_Bad_Changed_Gap_Name',
+  'contracts/test/Storage.sol:StorageUpgrade_ConsumeAndAddGap_V1',
+  'contracts/test/Storage.sol:StorageUpgrade_ConsumeAndAddGap_V2',
+  'contracts/test/Storage.sol:StorageUpgrade_ConsumeAndAddGap_V3',
+  'contracts/test/Storage.sol:StorageUpgrade_ConsumeAndAddGap_V3b',
+  'contracts/test/Storage.sol:StorageUpgrade_ConsumeAndAddGap_Storage_V1',
+  'contracts/test/Storage.sol:StorageUpgrade_ConsumeAndAddGap_Storage_V2',
 ];
 
 test.before(async t => {
@@ -117,3 +130,77 @@ test('insert vars without shrink gap (uint128)', t => {
   t.false(report.ok);
   t.snapshot(report.explain());
 });
+
+test('custom gap - shrinkgap', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V2_Ok');
+  const report = getReport(v1, v2);
+  t.true(report.ok);
+  t.is(report.explain(), '');
+});
+
+test('custom gap - insert var, did not shrink gaps', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V2_Bad');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('custom gap - insert var, shrank only first gap', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V2_Bad2');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('custom gap - switched gaps', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V2_Ok_Switched_Gaps');
+  const report = getReport(v1, v2);
+  t.true(report.ok);
+  t.is(report.explain(), '');
+});
+
+test('custom gap - insert var, did not shrink gaps, switched gaps', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V2_Bad_Switched_Gaps');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('custom gap - insert var, did not shrink gaps, changed first gap name', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_CustomGap_V2_Bad_Changed_Gap_Name');
+  const report = getReport(v1, v2);
+  t.false(report.ok);
+  t.snapshot(report.explain());
+});
+
+test('consume entire gap and add new gap of different size', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_V2');
+  const v3 = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_V3');
+
+  t.true(getReport(v1, v2).ok);
+  t.true(getReport(v2, v3).ok);
+  t.true(getReport(v1, v3).ok);
+});
+
+test('consume entire gap and add new gap of same size', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_V2');
+  const v3b = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_V3b');
+
+  t.true(getReport(v2, v3b).ok);
+  t.true(getReport(v1, v3b).ok);
+});
+
+test('consume partial gap and add new gap, storage contract pattern', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_Storage_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_ConsumeAndAddGap_Storage_V2');
+
+  t.true(getReport(v1, v2).ok);
+});

package/src/storage/report-gap.test.ts.md

@@ -57,3 +57,33 @@ Generated by [AVA](https://avajs.dev).
     `file.sol:1: Layout changed for \`__gap\` (uint128[49] -> uint128[49])␊
       - Slot changed from 1 to 2␊
       > Set __gap array to size 48`
+
+## custom gap - insert var, did not shrink gaps
+
+> Snapshot 1
+
+    `file.sol:1: Layout changed for \`__gap_part1\` (uint256[24] -> uint256[24])␊
+      - Slot changed from 1 to 2␊
+      > Set __gap_part1 array to size 23`
+
+## custom gap - insert var, shrank only first gap
+
+> Snapshot 1
+
+    `file.sol:1: Layout changed for \`__gap_part2\` (uint256[23] -> uint256[23])␊
+      - Slot changed from 27 to 29␊
+      > Set __gap_part2 array to size 21`
+
+## custom gap - insert var, did not shrink gaps, switched gaps
+
+> Snapshot 1
+
+    `file.sol:1: Renamed \`__gap_part1\` to \`__gap_part2\`␊
+    ␊
+    file.sol:1: Renamed \`__gap_part2\` to \`__gap_part1\``
+
+## custom gap - insert var, did not shrink gaps, changed first gap name
+
+> Snapshot 1
+
+    'file.sol:1: Renamed `__gap_part1` to `__gap`'

package/src/storage/report.ts

@@ -76,7 +76,7 @@ function getExpectedGapSize(original: StorageField, updated: StorageField) {
 function suggestGapSize(original: StorageField, updated: StorageField): string | undefined {
   const expectedSize = getExpectedGapSize(original, updated);
   if (expectedSize !== undefined) {
-    return `Set __gap array to size ${expectedSize}`;
+    return `Set ${updated.label} array to size ${expectedSize}`;
   }
 }