Merge pull request #1511 from CMS-Enterprise/MINT-3177/category_reord…

…ering_be

[MINT-3177]/category reordering be

.vscode/settings.json

@@ -29,7 +29,7 @@
     "AWS_S3_ECHIMP_BUCKET": "mint-app-echimp-uploads",
     "AWS_ECHIMP_CR_FILE_NAME": "FFS_CR_DATA.parquet",
     "AWS_ECHIMP_TDL_FILE_NAME": "TDL_DATA.parquet",
-    "AWS_ECHIMP_CACHE_TIME_MINS": 180,
+    "AWS_ECHIMP_CACHE_TIME_MINS": "180",
     "MINIO_ADDRESS": "http://localhost:9005",
     "MINIO_ACCESS_KEY": "minioadmin",
     "MINIO_SECRET_KEY": "minioadmin"

migrations/V181__Add_MTO_Category.sql

@@ -3,6 +3,7 @@ CREATE TABLE mto_category (
     name ZERO_STRING NOT NULL,
     parent_id UUID REFERENCES mto_category(id),
     model_plan_id UUID NOT NULL REFERENCES model_plan(id),
+    position INT NOT NULL,
 
     created_by UUID NOT NULL REFERENCES user_account(id),
     created_dts TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT CURRENT_TIMESTAMP,

migrations/V188__Add_MTO_Category_Reorder_Trigger.sql

@@ -0,0 +1,112 @@
+CREATE OR REPLACE FUNCTION update_position_based_on_parent_and_model_plan()
+RETURNS TRIGGER AS $$
+
+DECLARE
+    /*
+     This determines if we need to add or subtract a value from the position. It should be +1 or -1
+    */
+    position_adjustment INT;
+BEGIN
+
+    -- Avoid recursion by checking pg_trigger_depth()
+    -- depth of 0 means not created from inside a trigger
+    IF pg_trigger_depth() > 1 THEN
+        RETURN NEW;
+    END IF;
+
+    -- Handle Insert: Adjust positions of other categories if the inserted position conflicts
+    IF TG_OP = 'INSERT' THEN
+        -- Move categories with the same parent_id and model_plan_id that have a position >= NEW.position
+        position_adjustment := 1;  -- For insert, we increase positions of conflicting rows
+        UPDATE mto_category
+        SET position = position + position_adjustment,
+            modified_by = NEW.modified_by,
+            modified_dts = NEW.modified_dts
+        WHERE ((parent_id IS NULL AND NEW.parent_id IS NULL) OR (parent_id = NEW.parent_id))
+          AND ((model_plan_id IS NULL AND NEW.model_plan_id IS NULL) OR (model_plan_id = NEW.model_plan_id))
+          AND position >= NEW.position
+          AND id != NEW.id;  -- Exclude the newly inserted row
+
+    -- Handle Update: Reorder positions when a row's position is changed 
+    ELSIF TG_OP = 'UPDATE' THEN
+        -- Determine if record moved up or down
+        IF NEW.position > OLD.position THEN
+            position_adjustment := -1;
+        ELSE
+            position_adjustment := 1;
+        END IF;
+
+ /* Prevent updates to model_plan_id and parent_id as these are fixed for each category */
+        IF OLD.parent_id IS DISTINCT FROM NEW.parent_id AND OLD.model_plan_id IS DISTINCT FROM NEW.model_plan_id THEN
+        RAISE EXCEPTION 'updating model_plan_id or parent_id is not allows. Caught in trigger function update_position_based_on_parent_and_model_plan';
+        ELSIF OLD.parent_id IS NOT DISTINCT FROM NEW.parent_id AND OLD.model_plan_id IS NOT DISTINCT FROM NEW.model_plan_id THEN
+            IF position_adjustment = -1 THEN
+            /* Row moved down: Shift rows in the range [OLD.position + 1, NEW.position] up by 1 */
+                UPDATE mto_category
+                SET position = position + position_adjustment, 
+                    modified_by = NEW.modified_by,
+                    modified_dts = NEW.modified_dts
+                WHERE ((parent_id IS NULL AND NEW.parent_id IS NULL) OR (parent_id = NEW.parent_id))
+                  AND ((model_plan_id IS NULL AND NEW.model_plan_id IS NULL) OR (model_plan_id = NEW.model_plan_id))
+                  AND position > OLD.position AND position <= NEW.position
+                  AND id != NEW.id;  -- Exclude the updated row
+            ELSIF position_adjustment = 1 THEN
+            /* Row moved up: Shift rows in the range [NEW.position, OLD.position - 1] down by 1 */
+                UPDATE mto_category
+                SET position = position + position_adjustment,
+                    modified_by = NEW.modified_by,
+                    modified_dts = NEW.modified_dts
+                WHERE ((parent_id IS NULL AND NEW.parent_id IS NULL) OR (parent_id = NEW.parent_id))
+                  AND ((model_plan_id IS NULL AND NEW.model_plan_id IS NULL) OR (model_plan_id = NEW.model_plan_id))
+                  AND position < OLD.position AND position >= NEW.position
+                  AND id != NEW.id;  -- Exclude the updated row
+            END IF;
+        END IF;
+
+    -- Handle Delete: Move positions up for all categories after the deleted category
+    ELSIF TG_OP = 'DELETE' THEN
+        UPDATE mto_category
+        SET position = position - 1,
+            modified_by = OLD.modified_by,
+            modified_dts = OLD.modified_dts
+        WHERE ((parent_id IS NULL AND OLD.parent_id IS NULL) OR (parent_id = OLD.parent_id))
+          AND ((model_plan_id IS NULL AND OLD.model_plan_id IS NULL) OR (model_plan_id = OLD.model_plan_id))
+          AND position > OLD.position
+          AND id != OLD.id;  -- Exclude the deleted row
+    END IF;
+
+    RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
+COMMENT ON FUNCTION update_position_based_on_parent_and_model_plan() IS
+'This function is a trigger handler that manages adjustments to the position of rows in the mto_category table.
+It is invoked automatically after INSERT, UPDATE, or DELETE operations on the mto_category table.
+The function performs the following actions:
+
+1. When a new record is inserted (INSERT):
+   - It checks for existing records in the same parent-child and model-plan context that have a position greater than or equal to the new record’s position.
+   - The position of those records is incremented by 1 to make space for the new record at its intended position.
+
+2. When an existing record is updated (UPDATE):
+   - It compares the old position with the new position to determine whether the record moved up or down.
+   - Based on this comparison, it adjusts the positions of other records either by shifting them up or down, ensuring that no gaps or overlaps occur in the sequence.
+
+3. When a record is deleted (DELETE):
+   - It decreases the position of all records that are positioned below the deleted record’s original position, effectively "closing the gap" left by the deleted record.
+
+The function ensures that records are ordered sequentially within the same parent-child and model-plan context, maintaining the integrity of the position values across insert, update, and delete actions.';
+
+CREATE TRIGGER update_position_trigger
+AFTER INSERT OR UPDATE OR DELETE ON mto_category
+FOR EACH ROW
+EXECUTE FUNCTION update_position_based_on_parent_and_model_plan();
+
+
+COMMENT ON TRIGGER update_position_trigger ON mto_category IS
+'This trigger is responsible for invoking the update_position_based_on_parent_and_model_plan() function after any INSERT, UPDATE, or DELETE operation on the mto_category table.
+It ensures that position adjustments are performed automatically whenever a change is made to a record in the mto_category table.
+The trigger operates on each row affected by the INSERT, UPDATE, or DELETE operation, invoking the associated function to handle position management according to the type of operation performed.
+- INSERT: The trigger causes the function to adjust the position of other records when a new record is inserted.
+- UPDATE: The trigger ensures that any change in position will trigger adjustments for other records that might be affected by the position change.
+- DELETE: The trigger makes sure the function handles the case where a record is deleted and the remaining records positions need to be adjusted accordingly.
+The trigger guarantees that the integrity of the positions in the mto_category table is always maintained, ensuring proper ordering and minimizing potential conflicts between records.';