refactor: added reinitializer and storage gap to PluginRepo and moved events to IPluginRepo

packages/contracts/CHANGELOG.md

@@ -12,6 +12,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `VersionComparisonLib` to compare semantic versioning numbers.
 - Inherit `ProtocolVersion` in `Plugin`, `PluginCloneable`, `PluginUUPSUpgradeable`, `PluginSetup`, `PermissionCondition`, `PermissionConditionUpgradeable` `PluginSetupProcessor`, `PluginRepoRegistry`, `DAORegistry`, and `ENSSubdomainRegistrar`.
 - Added the `FunctionDeprecated` error to `DAO`.
+- Added a storage gap to `PluginRepo`.
+- Added `initializeFrom` placeholder function to `PluginRepo`.
 
 ### Changed
 
@@ -23,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Use the DAOs permission manager functionality to validate signatures.
 - Renamed `managingDAO` during deployment to `managmentDAO`.
 - Aligned contract names during deployment with the names given in `@aragon/osx-commons-configs`.
+- Move events `ReleaseMetadataUpdated`and `VersionCreated` from `PluginRepo` to `IPluginRepo`.
 
 ### Removed
 

packages/contracts/src/framework/plugin/repo/IPluginRepo.sol

@@ -23,4 +23,21 @@ interface IPluginRepo {
         bytes calldata _buildMetadata,
         bytes calldata _releaseMetadata
     ) external;
+
+    /// @notice Emitted if the same plugin setup exists in previous releases.
+    /// @param release The release number.
+    /// @param build The build number.
+    /// @param pluginSetup The address of the plugin setup contract.
+    /// @param buildMetadata The build metadata URI.
+    event VersionCreated(
+        uint8 release,
+        uint16 build,
+        address indexed pluginSetup,
+        bytes buildMetadata
+    );
+
+    /// @notice Emitted when a release's metadata was updated.
+    /// @param release The release number.
+    /// @param releaseMetadata The release metadata URI.
+    event ReleaseMetadataUpdated(uint8 release, bytes releaseMetadata);
 }

packages/contracts/src/framework/plugin/repo/PluginRepo.sol

@@ -96,23 +96,6 @@ contract PluginRepo is
     /// @notice Thrown if release does not exist.
     error ReleaseDoesNotExist();
 
-    /// @notice Thrown if the same plugin setup exists in previous releases.
-    /// @param release The release number.
-    /// @param build The build number.
-    /// @param pluginSetup The address of the plugin setup contract.
-    /// @param buildMetadata The build metadata URI.
-    event VersionCreated(
-        uint8 release,
-        uint16 build,
-        address indexed pluginSetup,
-        bytes buildMetadata
-    );
-
-    /// @notice Thrown when a release's metadata was updated.
-    /// @param release The release number.
-    /// @param releaseMetadata The release metadata URI.
-    event ReleaseMetadataUpdated(uint8 release, bytes releaseMetadata);
-
     /// @dev Used to disallow initializing the implementation contract by an attacker for extra safety.
     constructor() {
         _disableInitializers();
@@ -129,6 +112,22 @@ contract PluginRepo is
         _grant(address(this), initialOwner, UPGRADE_REPO_PERMISSION_ID);
     }
 
+    /// @notice Initializes the pluginRepo after an upgrade from a previous protocol version.
+    /// @param _previousProtocolVersion The semantic protocol version number of the previous DAO implementation contract this upgrade is transitioning from.
+    /// @param _initData The initialization data to be passed to via `upgradeToAndCall` (see [ERC-1967](https://docs.openzeppelin.com/contracts/4.x/api/proxy#ERC1967Upgrade)).
+    /// @dev This function is a placeholder until we require reinitialization.
+    function initializeFrom(
+        uint8[3] calldata _previousProtocolVersion,
+        bytes calldata _initData
+    ) external reinitializer(2) {
+        // Silences the unused function parameter warning.
+        _previousProtocolVersion;
+        _initData;
+
+        // Revert because this is a placeholder until this contract requires reinitialization.
+        revert();
+    }
+
     /// @inheritdoc IPluginRepo
     function createVersion(
         uint8 _release,
@@ -272,4 +271,7 @@ contract PluginRepo is
             _interfaceId == type(IProtocolVersion).interfaceId ||
             super.supportsInterface(_interfaceId);
     }
+
+    /// @notice This empty reserved space is put in place to allow future versions to add new variables without shifting down storage in the inheritance chain (see [OpenZeppelin's guide about storage gaps](https://docs.openzeppelin.com/contracts/4.x/upgradeable#storage_gaps)).
+    uint256[46] private __gap;
 }

packages/contracts/test/framework/plugin/plugin-repo.ts

@@ -11,6 +11,7 @@ import {
 } from '../../../typechain';
 import {PluginRepo__factory as PluginRepo_V1_0_0__factory} from '../../../typechain/@aragon/osx-v1.0.1/framework/plugin/repo/PluginRepo.sol';
 import {PluginRepo__factory as PluginRepo_V1_3_0__factory} from '../../../typechain/@aragon/osx-v1.3.0/framework/plugin/repo/PluginRepo.sol';
+import {OZ_INITIALIZED_SLOT_POSITION} from '../../../utils/storage';
 import {ZERO_BYTES32} from '../../test-utils/dao';
 import {osxContractsVersion} from '../../test-utils/protocol-version';
 import {tagHash} from '../../test-utils/psp/hash-helpers';
@@ -152,6 +153,13 @@ describe('PluginRepo', function () {
         expect(toProtocolVersion).to.deep.equal(osxContractsVersion());
       });
     });
+    describe('InitializeFrom', () => {
+      it('reverts because the function is a placeholder', async () => {
+        // Call `initializeFrom` with version 1.3.0. and revert
+        await expect(pluginRepo.initializeFrom([1, 3, 0], emptyBytes)).to.be
+          .reverted;
+      });
+    });
 
     describe('ERC-165', async () => {
       it('does not support the empty interface', async () => {
@@ -515,7 +523,7 @@ describe('PluginRepo', function () {
         ).to.be.revertedWithCustomError(pluginRepo, 'EmptyReleaseMetadata');
       });
 
-      it('successfuly updates metadata for the release that already exists', async () => {
+      it('updates metadata for the release that already exists and emits the "ReleaseMetadataUpdated" event', async () => {
         await pluginRepo.createVersion(
           1,
           pluginSetupMock.address,