Default user limits per DON family (#241)

* Default user limits per DON family

* Addressed PR comments and respected global limit

* Simplification of setUserDONOverride function

Author: ibrajer

contracts/gas-snapshots/workflow.gas-snapshot

@@ -28,7 +28,7 @@ contract WorkflowRegistry_activateWorkflow is WorkflowRegistrySetup {
   function test_activateWorkflow_WhenTheWorkflowExistsButOwnerDoesNotEqualCaller() external whenCallerIsLinked {
     // It reverts with CallerIsNotWorkflowOwner
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 10, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
 
     address user2 = makeAddr("user2");
     _linkOwner(s_user);
@@ -43,7 +43,7 @@ contract WorkflowRegistry_activateWorkflow is WorkflowRegistrySetup {
     // It returns immediately (no state change, no event)
     // set DON limit first
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 10, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
     _linkOwner(s_user);
     _upsertTestWorklow(WorkflowRegistry.WorkflowStatus.ACTIVE, false, s_user);
     vm.prank(s_user);
@@ -74,10 +74,10 @@ contract WorkflowRegistry_activateWorkflow is WorkflowRegistrySetup {
     // It reverts with MaxWorkflowsPerUserDONExceeded
     bytes32 wfId2 = keccak256("workflow-id2");
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 1, true);
+    s_registry.setDONLimit(s_donFamily, 100, 1);
     _linkOwner(s_user);
 
-    // add 2 worflows 1 active and 1 paused in a don with a limit of 1
+    // add 2 worflows 1 active and 1 paused in a don with a default user limit of 1
     vm.startPrank(s_user);
     s_registry.upsertWorkflow(
       s_workflowName,
@@ -107,6 +107,54 @@ contract WorkflowRegistry_activateWorkflow is WorkflowRegistrySetup {
     );
     s_registry.activateWorkflow(s_workflowId, s_donFamily);
     vm.stopPrank();
+
+    // user override to allow 2 workflows this time
+    vm.prank(s_owner);
+    s_registry.setUserDONOverride(s_user, s_donFamily, 2, true);
+
+    // now the activation of the 2nd workflow should succeed
+    vm.startPrank(s_user);
+    vm.expectEmit(true, true, true, false);
+    emit WorkflowRegistry.WorkflowActivated(s_workflowId, s_user, s_donFamily, "workflow-2");
+    s_registry.activateWorkflow(s_workflowId, s_donFamily);
+
+    // if we try to upsert another workflow in an active state, it should fail
+    bytes32 wfId3 = keccak256("workflow-id3");
+    vm.expectRevert(
+      abi.encodeWithSelector(WorkflowRegistry.MaxWorkflowsPerUserDONExceeded.selector, s_user, s_donFamily)
+    );
+    s_registry.upsertWorkflow(
+      "workflow-3",
+      s_tag,
+      wfId3,
+      WorkflowRegistry.WorkflowStatus.ACTIVE,
+      s_donFamily,
+      s_binaryUrl,
+      s_configUrl,
+      s_attributes,
+      false
+    );
+
+    // but we can upsert the same workflow in paused state
+    s_registry.upsertWorkflow(
+      "workflow-3",
+      s_tag,
+      wfId3,
+      WorkflowRegistry.WorkflowStatus.PAUSED,
+      s_donFamily,
+      s_binaryUrl,
+      s_configUrl,
+      s_attributes,
+      false
+    );
+
+    // but activating it should fail since the user override is now maxed out
+    vm.expectRevert(
+      abi.encodeWithSelector(WorkflowRegistry.MaxWorkflowsPerUserDONExceeded.selector, s_user, s_donFamily)
+    );
+    s_registry.activateWorkflow(wfId3, s_donFamily);
+
+    vm.stopPrank();
   }
 
   function test_activateWorkflow_WhenNoDONLimitIsSetGloballyForTheDonFamily()
@@ -130,10 +178,10 @@ contract WorkflowRegistry_activateWorkflow is WorkflowRegistrySetup {
     // It activates the workflow and emits WorkflowActivated
     bytes32 wfId2 = keccak256("workflow-id2");
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 2, true);
+    s_registry.setDONLimit(s_donFamily, 100, 2);
     _linkOwner(s_user);
 
-    // add 2 worflows 1 active and 1 paused in a don with a limit of 1
+    // add 2 worflows 1 active and 1 paused in a don with a default user limit of 2
     vm.startPrank(s_user);
     s_registry.upsertWorkflow(
       s_workflowName,

contracts/src/v0.8/workflow/dev/v2/WorkflowRegistry.sol

@@ -35,7 +35,7 @@ contract WorkflowRegistry_adminBatchPauseWorkflows is WorkflowRegistrySetup {
     workflowIds[1] = wfId2;
 
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 10, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
     _linkOwner(s_user);
 
     // add some workflows for a different user

contracts/src/v0.8/workflow/dev/v2/test/WorkflowRegistry/WorkflowRegistry.activateWorkflow.t.sol

@@ -19,7 +19,7 @@ contract WorkflowRegistry_adminPauseAllByDON is WorkflowRegistrySetup {
     // it pauses all of the workflows
     bytes32 wfId2 = keccak256("workflow-id2");
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 10, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
     _linkOwner(s_user);
 
     // add some workflows

contracts/src/v0.8/workflow/dev/v2/test/WorkflowRegistry/WorkflowRegistry.adminBatchPauseWorkflows.t.sol

@@ -19,7 +19,7 @@ contract WorkflowRegistry_adminPauseAllByOwner is WorkflowRegistrySetup {
     // it pauses all of the workflows
     bytes32 wfId2 = keccak256("workflow-id2");
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 10, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
     _linkOwner(s_user);
 
     // add some workflows

contracts/src/v0.8/workflow/dev/v2/test/WorkflowRegistry/WorkflowRegistry.adminPauseAllByDON.t.sol

@@ -19,7 +19,7 @@ contract WorkflowRegistry_adminPauseWorkflow is WorkflowRegistrySetup {
   function test_adminPauseWorkflow_WhenWorkflowStatusIsPAUSED() external {
     // setup: configure a DON limit and register a workflow as PAUSED
     vm.startPrank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 10, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
     (bytes32 ownerProof, bytes memory sig) = _getLinkProofSignature(s_owner);
     s_registry.linkOwner(s_validityTimestamp, ownerProof, sig);
 
@@ -51,7 +51,7 @@ contract WorkflowRegistry_adminPauseWorkflow is WorkflowRegistrySetup {
   function test_adminPauseWorkflow_WhenWorkflowStatusIsACTIVE() external {
     // setup: configure a DON limit and register a workflow as ACTIVE
     vm.startPrank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 10, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
     (bytes32 ownerProof, bytes memory sig) = _getLinkProofSignature(s_owner);
     s_registry.linkOwner(s_validityTimestamp, ownerProof, sig);
 

contracts/src/v0.8/workflow/dev/v2/test/WorkflowRegistry/WorkflowRegistry.adminPauseAllByOwner.t.sol

@@ -97,7 +97,7 @@ contract WorkflowRegistry_batchActivateWorkflows is WorkflowRegistrySetup {
     workflowIds[1] = wfId2;
 
     vm.prank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 1, true);
+    s_registry.setDONLimit(s_donFamily, 100, 1);
 
     // add some workflows
     vm.startPrank(s_user);

contracts/src/v0.8/workflow/dev/v2/test/WorkflowRegistry/WorkflowRegistry.adminPauseWorkflow.t.sol

@@ -16,17 +16,20 @@ contract WorkflowRegistry_getDonConfigs is WorkflowRegistrySetup {
 
     // set the don configs
     vm.startPrank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 100, true);
-    s_registry.setDONLimit("fast-pool", 200, true);
-    s_registry.setDONLimit("slow-pool", 150, true);
+    s_registry.setDONLimit(s_donFamily, 100, 10);
+    s_registry.setDONLimit("fast-pool", 200, 20);
+    s_registry.setDONLimit("slow-pool", 150, 15);
     vm.stopPrank();
     WorkflowRegistry.DonConfigView[] memory list = s_registry.getDonConfigs(0, 100);
     assertEq(list.length, 3);
     assertEq(list[0].family, s_donFamily);
-    assertEq(list[0].limit, 100);
+    assertEq(list[0].donLimit, 100);
+    assertEq(list[0].defaultUserLimit, 10);
     assertEq(list[1].family, "fast-pool");
-    assertEq(list[1].limit, 200);
+    assertEq(list[1].donLimit, 200);
+    assertEq(list[1].defaultUserLimit, 20);
     assertEq(list[2].family, "slow-pool");
-    assertEq(list[2].limit, 150);
+    assertEq(list[2].donLimit, 150);
+    assertEq(list[2].defaultUserLimit, 15);
   }
 }

contracts/src/v0.8/workflow/dev/v2/test/WorkflowRegistry/WorkflowRegistry.batchActivateWorkflows.t.sol

@@ -13,9 +13,9 @@ contract WorkflowRegistry_getEvents is WorkflowRegistrySetup {
 
   modifier whenThereIsMoreThan1Event() {
     vm.startPrank(s_owner);
-    s_registry.setDONLimit(s_donFamily, 100, true);
-    s_registry.setDONLimit(s_donFamily, 200, true);
-    s_registry.setDONLimit(s_donFamily, 150, true); // should push three events to event records
+    s_registry.setDONLimit(s_donFamily, 100, 10);
+    s_registry.setDONLimit(s_donFamily, 200, 20);
+    s_registry.setDONLimit(s_donFamily, 150, 15); // should push three events to event records
     vm.stopPrank();
     _;
   }