@openzeppelin/upgrades-core 1.13.0 → 1.14.1

package/src/storage/report-rename-retype.test.ts.md

@@ -0,0 +1,44 @@
+# Snapshot report for `src/storage/report-rename-retype.test.ts`
+
+The actual snapshot is saved in `report-rename-retype.test.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## succesful rename
+
+> Snapshot 1
+
+    ''
+
+## succesful retype
+
+> Snapshot 1
+
+    ''
+
+## wrongly reported retype
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`x\` to an incompatible type␊
+      - Bad upgrade from bool to uint8`
+
+## rightly reported retype but incompatible new type
+
+> Snapshot 1
+
+    `file.sol:1: Layout changed for \`x\` (bool -> bytes32)␊
+      - Number of bytes changed from 1 to 32`
+
+## confusing bad retype
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`x\` to an incompatible type␊
+      - Bad upgrade from bool to uint8`
+
+## non-hardcoded retype
+
+> Snapshot 1
+
+    ''

package/src/storage/report.test.ts

@@ -59,6 +59,13 @@ test('obvious mismatch', t => {
   t.snapshot(report.explain());
 });
 
+test('function visibility change', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_FunctionType_Visibility_V1');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_FunctionType_Visibility_V2_Bad');
+  const report = getReport(v1, v2);
+  t.snapshot(report.explain());
+});
+
 test('array', t => {
   const v1 = t.context.extractStorageLayout('StorageUpgrade_Array_V1');
   const v2 = t.context.extractStorageLayout('StorageUpgrade_Array_V2_Bad');

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

@@ -90,6 +90,17 @@ Generated by [AVA](https://avajs.dev).
     file.sol:1: Upgraded \`a1\` to an incompatible type␊
       - Bad upgrade from uint256[] to mapping(uint256 => uint256)`
 
+## function visibility change
+
+> Snapshot 1
+
+    `file.sol:1: Upgraded \`s1\` to an incompatible type␊
+      - Bad upgrade from struct StorageUpgrade_FunctionType_Visibility_V1.S to struct StorageUpgrade_FunctionType_Visibility_V2_Bad.S␊
+      - In struct StorageUpgrade_FunctionType_Visibility_V2_Bad.S␊
+        - Upgraded \`m\` to an incompatible type␊
+          - Bad upgrade from function () to function () external␊
+            Different visibility`
+
 ## array
 
 > Snapshot 1

package/src/storage/report.ts

@@ -2,7 +2,7 @@ import _chalk from 'chalk';
 
 import type { BasicOperation } from '../levenshtein';
 import type { ParsedTypeDetailed } from './layout';
-import type { StorageOperation, StorageItem, StorageField, TypeChange, EnumOperation } from './compare';
+import type { StorageOperation, StorageItem, StorageField, TypeChange, EnumOperation, LayoutChange } from './compare';
 import { itemize, itemizeWith } from '../utils/itemize';
 import { indent } from '../utils/indent';
 import { assert } from '../utils/assert';
@@ -22,8 +22,12 @@ export class LayoutCompatibilityReport {
     const chalk = new _chalk.Instance({ level: color && _chalk.supportsColor ? _chalk.supportsColor.level : 0 });
     const res = [];
 
-    for (const op of this.ops) {
+    for (const [i, op] of this.ops.entries()) {
       const src = 'updated' in op ? op.updated.src : op.original.contract;
+      // Only print layoutchange if it's the first op, otherwise we assume it will be explained by previous ops.
+      if (op.kind === 'layoutchange' && i !== 0) {
+        continue;
+      }
       res.push(
         chalk.bold(src) + ':' + indent(explainStorageOperation(op, { kind: 'layout', allowAppend: true }), 2, 1),
       );
@@ -52,13 +56,20 @@ function explainStorageOperation(op: StorageOperation<StorageField>, ctx: Storag
           : [];
       return `Upgraded ${label(op.updated)} to an incompatible type\n` + itemize(basic, ...details);
     }
-
     case 'rename':
       return `Renamed ${label(op.original)} to ${label(op.updated)}`;
 
     case 'replace':
       return `Replaced ${label(op.original)} with ${label(op.updated)} of incompatible type`;
 
+    case 'layoutchange': {
+      return (
+        `Layout ${op.change.uncertain ? 'could have changed' : 'changed'} for ${label(op.updated)} ` +
+        `(${op.original.type.item.label} -> ${op.updated.type.item.label})\n` +
+        describeLayoutTransition(op.change)
+      ).trimEnd();
+    }
+
     default: {
       const title = explainBasicOperation(op, t => t.label);
       const hints = [];
@@ -90,6 +101,9 @@ function explainStorageOperation(op: StorageOperation<StorageField>, ctx: Storag
 
 function explainTypeChange(ch: TypeChange): string {
   switch (ch.kind) {
+    case 'visibility change':
+      return `Bad upgrade ${describeTransition(ch.original, ch.updated)}\nDifferent visibility`;
+
     case 'obvious mismatch':
     case 'struct members':
     case 'enum members':
@@ -172,7 +186,16 @@ function explainTypeChangeDetails(ch: TypeChange): string | undefined {
       const { allowAppend } = ch;
       return (
         `In ${ch.updated.item.label}\n` +
-        itemize(...ch.ops.map(op => explainStorageOperation(op, { kind: 'struct', allowAppend })))
+        itemize(
+          ...ch.ops.flatMap((op, i) => {
+            if (op.kind === 'layoutchange' && i !== 0) {
+              // Only print layoutchange if it's the first op, otherwise we assume it will be explained by previous ops.
+              return [];
+            } else {
+              return [explainStorageOperation(op, { kind: 'struct', allowAppend })];
+            }
+          }),
+        )
       );
     }
 
@@ -215,6 +238,18 @@ function describeTransition(original: ParsedTypeDetailed, updated: ParsedTypeDet
   }
 }
 
+function describeLayoutTransition(change: LayoutChange): string {
+  const res = [];
+  for (const k of ['slot', 'offset', 'bytes'] as const) {
+    const ch = change[k];
+    if (ch) {
+      const label = (k === 'bytes' ? 'number of bytes' : k).replace(/^./, c => c.toUpperCase());
+      res.push(`${label} changed from ${ch.from} to ${ch.to}`);
+    }
+  }
+  return itemize(...res);
+}
+
 function label(variable: { label: string }): string {
   return '`' + variable.label + '`';
 }

package/src/storage.test.ts

@@ -23,11 +23,15 @@ test.before(async t => {
   }
   const solcOutput: SolcOutput = buildInfo.output;
   const contracts: Record<string, ContractDefinition> = {};
+  const storageLayouts: Record<string, StorageLayout> = {};
   for (const def of findAll('ContractDefinition', solcOutput.sources['contracts/test/Storage.sol'].ast)) {
     contracts[def.name] = def;
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    storageLayouts[def.name] = solcOutput.contracts['contracts/test/Storage.sol'][def.name].storageLayout!;
   }
   const deref = astDereferencer(solcOutput);
-  t.context.extractStorageLayout = name => extractStorageLayout(contracts[name], dummyDecodeSrc, deref);
+  t.context.extractStorageLayout = name =>
+    extractStorageLayout(contracts[name], dummyDecodeSrc, deref, storageLayouts[name]);
 });
 
 const dummyDecodeSrc = () => 'file.sol:1';
@@ -175,7 +179,7 @@ test('storage upgrade with structs', t => {
       change: {
         kind: 'struct members',
         ops: {
-          length: 1,
+          length: 2,
           0: { kind: 'delete' },
         },
       },
@@ -464,6 +468,12 @@ test('storage upgrade with enum key in mapping', t => {
   });
 });
 
+test('storage upgrade with embedded enum inside struct type', t => {
+  const v1 = t.context.extractStorageLayout('StorageUpgrade_StructEnum_V2');
+  const v2 = t.context.extractStorageLayout('StorageUpgrade_StructEnum_V2');
+  t.deepEqual(getStorageUpgradeErrors(v1, v2), []);
+});
+
 function stabilizeStorageLayout(layout: StorageLayout) {
   return {
     storage: layout.storage.map(s => ({ ...s, type: stabilizeTypeIdentifier(s.type) })),