|
| 1 | +import frappe |
| 2 | + |
| 3 | + |
| 4 | +def execute(): |
| 5 | + """ |
| 6 | + Fix duplicate DM channels by populating dm_user fields and merging duplicates in a single pass. |
| 7 | +
|
| 8 | + The unique constraint on dm_user_1/dm_user_2 gets added via on_doctype_update() before patches run. |
| 9 | + If we populate dm_user fields first for ALL channels, duplicates would violate the constraint. |
| 10 | + So we must process channels one by one - either set dm_user fields OR merge into existing. |
| 11 | +
|
| 12 | + Logic: |
| 13 | + 1. Loop through all DM channels (oldest first) |
| 14 | + 2. For each channel, get canonical user pair from channel members |
| 15 | + 3. If pair already processed → merge this channel into primary |
| 16 | + 4. If pair is new → set dm_user fields, mark as primary |
| 17 | + """ |
| 18 | + |
| 19 | + # track processed pairs: {(dm_user_1, dm_user_2): primary_channel_id} |
| 20 | + processed_pairs = {} |
| 21 | + |
| 22 | + raven_channel = frappe.qb.DocType("Raven Channel") |
| 23 | + |
| 24 | + # get all DM channels ordered by creation (oldest first becomes primary) |
| 25 | + dm_channels = ( |
| 26 | + frappe.qb.from_(raven_channel) |
| 27 | + .select(raven_channel.name) |
| 28 | + .where(raven_channel.is_direct_message == 1) |
| 29 | + .orderby(raven_channel.creation) |
| 30 | + ).run(as_dict=True) |
| 31 | + |
| 32 | + for channel in dm_channels: |
| 33 | + # get canonical user pair from channel members |
| 34 | + user_pair = get_user_pair_from_members(channel.name) |
| 35 | + |
| 36 | + if not user_pair: |
| 37 | + frappe.log_error( |
| 38 | + f"Could not determine user pair for DM channel {channel.name}", |
| 39 | + "Patch: fix_duplicate_dm_channels", |
| 40 | + ) |
| 41 | + continue |
| 42 | + |
| 43 | + dm_user_1, dm_user_2 = user_pair |
| 44 | + pair_key = (dm_user_1, dm_user_2) |
| 45 | + |
| 46 | + # if the pair has already been processed, merge the channel into the primary |
| 47 | + if pair_key in processed_pairs: |
| 48 | + # duplicate - merge into primary |
| 49 | + primary_channel = processed_pairs[pair_key] |
| 50 | + merge_channel_into_primary(channel.name, primary_channel) |
| 51 | + else: |
| 52 | + # first occurrence - set dm_user fields and track as primary |
| 53 | + frappe.db.set_value( |
| 54 | + "Raven Channel", |
| 55 | + channel.name, |
| 56 | + {"dm_user_1": dm_user_1, "dm_user_2": dm_user_2}, |
| 57 | + update_modified=False, |
| 58 | + ) |
| 59 | + processed_pairs[pair_key] = channel.name |
| 60 | + |
| 61 | + |
| 62 | +def get_user_pair_from_members(channel_id: str) -> tuple | None: |
| 63 | + """Get canonical user pair from channel members. Returns (dm_user_1, dm_user_2) or None.""" |
| 64 | + users = frappe.get_all( |
| 65 | + "Raven Channel Member", |
| 66 | + filters={"channel_id": channel_id}, |
| 67 | + pluck="user_id", |
| 68 | + ) |
| 69 | + |
| 70 | + if len(users) == 2: |
| 71 | + # Canonical order: dm_user_1 > dm_user_2 (alphabetically) |
| 72 | + if users[0] > users[1]: |
| 73 | + return (users[0], users[1]) |
| 74 | + return (users[1], users[0]) |
| 75 | + elif len(users) == 1: |
| 76 | + # Self message |
| 77 | + return (users[0], users[0]) |
| 78 | + |
| 79 | + return None |
| 80 | + |
| 81 | + |
| 82 | +def merge_channel_into_primary(duplicate_channel: str, primary_channel: str): |
| 83 | + """Merge a duplicate channel into the primary channel.""" |
| 84 | + |
| 85 | + # Migrate all linked records |
| 86 | + migrate_linked_records(primary_channel, duplicate_channel) |
| 87 | + |
| 88 | + # Migrate channel members |
| 89 | + migrate_channel_members(primary_channel, duplicate_channel) |
| 90 | + |
| 91 | + # Delete the duplicate channel |
| 92 | + frappe.db.delete("Raven Channel", {"name": duplicate_channel}) |
| 93 | + |
| 94 | + |
| 95 | +def migrate_linked_records(primary_channel: str, duplicate_channel: str): |
| 96 | + """Move all linked records from duplicate to primary channel.""" |
| 97 | + |
| 98 | + linked_doctypes = [ |
| 99 | + ("Raven Message", "channel_id"), |
| 100 | + ("Raven Message Reaction", "channel_id"), |
| 101 | + ("Raven Pinned Channels", "channel_id"), |
| 102 | + ("Raven Incoming Webhook", "channel_id"), |
| 103 | + ("Raven Scheduler Event", "channel"), |
| 104 | + ("Raven Scheduler Event", "dm"), |
| 105 | + ("Raven Webhook", "channel_id"), |
| 106 | + ] |
| 107 | + |
| 108 | + for doctype, field in linked_doctypes: |
| 109 | + table = frappe.qb.DocType(doctype) |
| 110 | + if not table: |
| 111 | + continue |
| 112 | + |
| 113 | + frappe.qb.update(table).set(field, primary_channel).where( |
| 114 | + table[field] == duplicate_channel |
| 115 | + ).run() |
| 116 | + |
| 117 | + |
| 118 | +def migrate_channel_members(primary_channel: str, duplicate_channel: str): |
| 119 | + """Migrate members from duplicate to primary, preserving admin status.""" |
| 120 | + |
| 121 | + # Preserve admin status - if user was admin in duplicate, make them admin in primary |
| 122 | + frappe.db.sql( |
| 123 | + """ |
| 124 | + UPDATE `tabRaven Channel Member` |
| 125 | + SET is_admin = 1 |
| 126 | + WHERE channel_id = %s |
| 127 | + AND user_id IN ( |
| 128 | + SELECT user_id FROM ( |
| 129 | + SELECT user_id FROM `tabRaven Channel Member` |
| 130 | + WHERE channel_id = %s AND is_admin = 1 |
| 131 | + ) AS admin_users |
| 132 | + ) |
| 133 | + """, |
| 134 | + (primary_channel, duplicate_channel), |
| 135 | + ) |
| 136 | + |
| 137 | + # Move members that don't already exist in primary |
| 138 | + frappe.db.sql( |
| 139 | + """ |
| 140 | + UPDATE `tabRaven Channel Member` |
| 141 | + SET channel_id = %s |
| 142 | + WHERE channel_id = %s |
| 143 | + AND user_id NOT IN ( |
| 144 | + SELECT user_id FROM ( |
| 145 | + SELECT user_id FROM `tabRaven Channel Member` WHERE channel_id = %s |
| 146 | + ) AS existing_members |
| 147 | + ) |
| 148 | + """, |
| 149 | + (primary_channel, duplicate_channel, primary_channel), |
| 150 | + ) |
| 151 | + |
| 152 | + # Delete remaining members from duplicate (they already exist in primary) |
| 153 | + frappe.db.delete("Raven Channel Member", {"channel_id": duplicate_channel}) |
0 commit comments