Improve error message details

OpenZeppelin · Dec 10, 2024 · c08ecfd · c08ecfd
1 parent b65c2b8
commit c08ecfd
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 9 deletions.
diff --git a/packages/core/src/validate-initializers.test.ts b/packages/core/src/validate-initializers.test.ts
@@ -128,7 +128,7 @@ testValid(
   'InitializationOrder_Duplicate_Bad',
   'transparent',
   false,
-  'Contract has multiple calls to a parent initializer',
+  'Contract has duplicate calls to initializer `__B_init` from parent contract `B`',
 );
 testValid('InitializationOrder_Duplicate_UnsafeAllow_Contract', 'transparent', true);
 testValid('InitializationOrder_Duplicate_UnsafeAllow_Function', 'transparent', true);

diff --git a/packages/core/src/validate/overrides.ts b/packages/core/src/validate/overrides.ts
@@ -83,19 +83,19 @@ export const ValidationErrorUnsafeMessages: Record<ValidationError['kind'], stri
   ],
   'missing-initializer': [
     `You are using the \`unsafeAllow.missing-initializer\` flag.`,
-    `Make sure you have manually checked that the contract has an initializer and that it correct calls any parent initializers.`,
+    `Make sure you have manually checked that the contract has an initializer and that it correctly calls any parent initializers.`,
   ],
   'missing-initializer-call': [
     `You are using the \`unsafeAllow.missing-initializer-call\` flag.`,
-    `Make sure you have manually checked that the contract has an initializer and that it correct calls any parent initializers.`,
+    `Make sure you have manually checked that the contract initializer calls all parent initializers.`,
   ],
   'duplicate-initializer-call': [
     `You are using the \`unsafeAllow.duplicate-initializer-call\` flag.`,
-    `Make sure you have manually checked that the contract has an initializer and that it correct calls any parent initializers.`,
+    `Make sure you have manually checked that the contract initializer calls each parent initializer only once.`,
   ],
   'incorrect-initializer-order': [
     `You are using the \`unsafeAllow.incorrect-initializer-order\` flag.`,
-    `Make sure you have manually checked that the contract has an initializer and that it correct calls any parent initializers.`,
+    `Make sure you have manually checked that the contract initializer calls parent initializers in linearized inheritance order.`,
   ],
 };
 

diff --git a/packages/core/src/validate/report.ts b/packages/core/src/validate/report.ts
@@ -83,7 +83,7 @@ const errorInfo: ErrorDescriptions<ValidationError> = {
     link: 'https://zpl.in/upgrades/error-001',
   },
   'duplicate-initializer-call': {
-    msg: () => `Contract has multiple calls to a parent initializer`,
+    msg: e => `Contract has duplicate calls to initializer \`${e.parentInitializer}\` from parent contract \`${e.parentContract}\``,
     hint: () => `Only call each parent initializer once`,
     link: 'https://zpl.in/upgrades/error-001',
   },

diff --git a/packages/core/src/validate/run.ts b/packages/core/src/validate/run.ts
@@ -79,16 +79,22 @@ interface ValidationErrorWithName extends ValidationErrorBase {
     | 'internal-function-storage';
 }
 
-interface ValidationErrorInitializerCall extends ValidationErrorBase {
-  kind: 'missing-initializer' | 'missing-initializer-call' | 'duplicate-initializer-call';
+interface ValidationErrorInitializerMissing extends ValidationErrorBase {
+  kind: 'missing-initializer' | 'missing-initializer-call';
+}
+
+interface ValidationErrorInitializerDuplicate extends ValidationErrorBase {
+  kind: 'duplicate-initializer-call';
+  parentInitializer: string;
+  parentContract: string;
 }
 
 interface ValidationErrorInitializerOrder extends ValidationErrorBase {
   kind: 'incorrect-initializer-order';
   expectedLinearization: string[];
 }
 
-type ValidationErrorInitializer = ValidationErrorInitializerCall | ValidationErrorInitializerOrder;
+type ValidationErrorInitializer = ValidationErrorInitializerMissing | ValidationErrorInitializerDuplicate | ValidationErrorInitializerOrder;
 
 interface ValidationErrorConstructor extends ValidationErrorBase {
   kind: 'constructor';
@@ -709,6 +715,8 @@ function* getInitializerErrors(
                   yield {
                     kind: 'duplicate-initializer-call',
                     src: decodeSrc(fnCall),
+                    parentInitializer: foundParentInitializer.name,
+                    parentContract: baseName,
                   };
                 }
                 calledInitializerIds.push(referencedFn);