# Buggy code
def _purge_history_txn(self, txn, room_id, token, delete_local_events):
    # Tables that should be pruned:
    #     event_auth
    #     event_backward_extremities
    #     event_edges
    #     event_forward_extremities
    #     event_json
    #     event_push_actions
    #     event_reference_hashes
    #     event_relations
    #     event_search
    #     event_to_state_groups
    #     events
    #     rejections
    #     room_depth
    #     state_groups
    #     state_groups_state
    #     destination_rooms

    # we will build a temporary table listing the events so that we don't
    # have to keep shovelling the list back and forth across the
    # connection. Annoyingly the python sqlite driver commits the
    # transaction on CREATE, so let's do this first.
    #
    # furthermore, we might already have the table from a previous (failed)
    # purge attempt, so let's drop the table first.

    txn.execute("DROP TABLE IF EXISTS events_to_purge")

    txn.execute(
        "CREATE TEMPORARY TABLE events_to_purge ("
        "    event_id TEXT NOT NULL,"
        "    should_delete BOOLEAN NOT NULL"
        ")"
    )

    # First ensure that we're not about to delete all the forward extremeties
    txn.execute(
        "SELECT e.event_id, e.depth FROM events as e "
        "INNER JOIN event_forward_extremities as f "
        "ON e.event_id = f.event_id "
        "AND e.room_id = f.room_id "
        "WHERE f.room_id = ?",
        (room_id,),
    )
    rows = txn.fetchall()
    max_depth = max(row[1] for row in rows)

    if max_depth < token.topological:
        # We need to ensure we don't delete all the events from the database
        # otherwise we wouldn't be able to send any events (due to not
        # having any backwards extremeties)
        raise SynapseError(
            400, "topological_ordering is greater than forward extremeties"
        )

    logger.info("[purge] looking for events to delete")

    should_delete_expr = "state_key IS NULL"
    should_delete_params = ()  # type: Tuple[Any, ...]
    if not delete_local_events:
        should_delete_expr += " AND event_id NOT LIKE ?"

        # We include the parameter twice since we use the expression twice
        should_delete_params += ("%:" + self.hs.hostname, "%:" + self.hs.hostname)

    should_delete_params += (room_id, token.topological)

    # Note that we insert events that are outliers and aren't going to be
    # deleted, as nothing will happen to them.
    txn.execute(
        "INSERT INTO events_to_purge"
        " SELECT event_id, %s"
        " FROM events AS e LEFT JOIN state_events USING (event_id)"
        " WHERE (NOT outlier OR (%s)) AND e.room_id = ? AND topological_ordering < ?"
        % (should_delete_expr, should_delete_expr),
        should_delete_params,
    )

    # We create the indices *after* insertion as that's a lot faster.

    # create an index on should_delete because later we'll be looking for
    # the should_delete / shouldn't_delete subsets
    txn.execute(
        "CREATE INDEX events_to_purge_should_delete ON events_to_purge(should_delete)"
    )

    # We do joins against events_to_purge for e.g. calculating state
    # groups to purge, etc., so lets make an index.
    txn.execute("CREATE INDEX events_to_purge_id ON events_to_purge(event_id)")

    txn.execute("SELECT event_id, should_delete FROM events_to_purge")
    event_rows = txn.fetchall()
    logger.info(
        "[purge] found %i events before cutoff, of which %i can be deleted",
        len(event_rows),
        sum(1 for e in event_rows if e[1]),
    )

    logger.info("[purge] Finding new backward extremities")

    # We calculate the new entries for the backward extremeties by finding
    # events to be purged that are pointed to by events we're not going to
    # purge.
    txn.execute(
        "SELECT DISTINCT e.event_id FROM events_to_purge AS e"
        " INNER JOIN event_edges AS ed ON e.event_id = ed.prev_event_id"
        " LEFT JOIN events_to_purge AS ep2 ON ed.event_id = ep2.event_id"
        " WHERE ep2.event_id IS NULL"
    )
    new_backwards_extrems = txn.fetchall()

    logger.info("[purge] replacing backward extremities: %r", new_backwards_extrems)

    txn.execute("DELETE FROM event_backward_extremities WHERE room_id = ?", (room_id,))

    # Update backward extremeties
    txn.execute_batch(
        "INSERT INTO event_backward_extremities (room_id, event_id) VALUES (?, ?)",
        [(room_id, event_id) for (event_id,) in new_backwards_extrems],
    )

    logger.info("[purge] finding state groups referenced by deleted events")

    # Get all state groups that are referenced by events that are to be
    # deleted.
    txn.execute(
        """
            SELECT DISTINCT state_group FROM events_to_purge
            INNER JOIN event_to_state_groups USING (event_id)
        """
    )

    referenced_state_groups = {sg for (sg,) in txn}
    logger.info(
        "[purge] found %i referenced state groups", len(referenced_state_groups)
    )

    logger.info("[purge] removing events from event_to_state_groups")
    txn.execute(
        "DELETE FROM event_to_state_groups "
        "WHERE event_id IN (SELECT event_id from events_to_purge)"
    )
    for event_id, _ in event_rows:
        txn.call_after(self._get_state_group_for_event.invalidate, (event_id,))

    # Delete all remote non-state events
    for table in (
        "events",
        "event_json",
        "event_auth",
        "event_edges",
        "event_forward_extremities",
        "event_reference_hashes",
        "event_relations",
        "event_search",
        "rejections",
    ):
        logger.info("[purge] removing events from %s", table)

        txn.execute(
            "DELETE FROM %s WHERE event_id IN ("
            "    SELECT event_id FROM events_to_purge WHERE should_delete"
            ")" % (table,)
        )

    # event_push_actions lacks an index on event_id, and has one on
    # (room_id, event_id) instead.
    for table in ("event_push_actions",):
        logger.info("[purge] removing events from %s", table)

        txn.execute(
            "DELETE FROM %s WHERE room_id = ? AND event_id IN ("
            "    SELECT event_id FROM events_to_purge WHERE should_delete"
            ")" % (table,),
            (room_id,),
        )

    # Mark all state and own events as outliers
    logger.info("[purge] marking remaining events as outliers")
    txn.execute(
        "UPDATE events SET outlier = ?"
        " WHERE event_id IN ("
        "    SELECT event_id FROM events_to_purge "
        "    WHERE NOT should_delete"
        ")",
        (True,),
    )

    # synapse tries to take out an exclusive lock on room_depth whenever it
    # persists events (because upsert), and once we run this update, we
    # will block that for the rest of our transaction.
    #
    # So, let's stick it at the end so that we don't block event
    # persistence.
    #
    # We do this by calculating the minimum depth of the backwards
    # extremities. However, the events in event_backward_extremities
    # are ones we don't have yet so we need to look at the events that
    # point to it via event_edges table.
    txn.execute(
        """
            SELECT COALESCE(MIN(depth), 0)
            FROM event_backward_extremities AS eb
            INNER JOIN event_edges AS eg ON eg.prev_event_id = eb.event_id
            INNER JOIN events AS e ON e.event_id = eg.event_id
            WHERE eb.room_id = ?
        """,
        (room_id,),
    )
    (min_depth,) = txn.fetchone()

    logger.info("[purge] updating room_depth to %d", min_depth)

    txn.execute(
        "UPDATE room_depth SET min_depth = ? WHERE room_id = ?",
        (min_depth, room_id),
    )

    # finally, drop the temp table. this will commit the txn in sqlite,
    # so make sure to keep this actually last.
    txn.execute("DROP TABLE events_to_purge")

    logger.info("[purge] done")

    return referenced_state_groups


# Traceback (twisted.internet.defer.FirstError)
synapse.http.server: [POST-10040] Failed handle request via 'JoinRoomAliasServlet': <XForwardedForRequest at 0x7f57646fa970 method='POST' uri='/_matrix/client/r0/join/%23synapse%3Amatrix.org' clientproto='HTTP/1.1' site='8008'>
Traceback (most recent call last):
File "/usr/lib/python3.9/site-packages/synapse/http/server.py", line 252, in _async_render_wrapper
callback_return = await self._async_render(request)
File "/usr/lib/python3.9/site-packages/synapse/http/server.py", line 430, in _async_render
callback_return = await raw_callback_return
File "/usr/lib/python3.9/site-packages/synapse/rest/client/v1/room.py", line 301, in on_POST
await self.room_member_handler.update_membership(
File "/usr/lib/python3.9/site-packages/synapse/handlers/room_member.py", line 333, in update_membership
result = await self.update_membership_locked(
File "/usr/lib/python3.9/site-packages/synapse/handlers/room_member.py", line 549, in update_membership_locked
remote_join_response = await self._remote_join(
File "/usr/lib/python3.9/site-packages/synapse/handlers/room_member.py", line 1091, in _remote_join
event_id, stream_id = await self.federation_handler.do_invite_join(
File "/usr/lib/python3.9/site-packages/synapse/handlers/federation.py", line 1400, in do_invite_join
max_stream_id = await self._persist_auth_tree(
File "/usr/lib/python3.9/site-packages/synapse/handlers/federation.py", line 2050, in _persist_auth_tree
await self.persist_events_and_notify(
File "/usr/lib/python3.9/site-packages/synapse/handlers/federation.py", line 2925, in persist_events_and_notify
events, max_stream_token = await self.storage.persistence.persist_events(
File "/usr/lib/python3.9/site-packages/synapse/storage/persist_events.py", line 262, in persist_events
ret_vals = await make_deferred_yieldable(
twisted.internet.defer.FirstError: FirstError[#0, [Failure instance: Traceback: <class 'psycopg2.errors.UniqueViolation'>: duplicate key value violates unique constraint "event_auth_chains_pkey"
DETAIL:  Key (event_id)=($e9U026auDHIgaZPAqlblvPupACjl7jcZDblP970dJPs) already exists.

/usr/lib/python3.9/site-packages/synapse/metrics/background_process_metrics.py:208:run
--- <exception caught here> ---
/usr/lib/python3.9/site-packages/synapse/storage/persist_events.py:172:handle_queue_loop
/usr/lib/python3.9/site-packages/synapse/storage/persist_events.py:324:persisting_queue
/usr/lib/python3.9/site-packages/synapse/storage/persist_events.py:532:_persist_events
/usr/lib/python3.9/site-packages/synapse/storage/databases/main/events.py:171:_persist_events_and_state_updates
/usr/lib/python3.9/site-packages/synapse/storage/database.py:661:runInteraction
/usr/lib/python3.9/site-packages/synapse/storage/database.py:744:runWithConnection
/usr/lib64/python3.9/site-packages/twisted/python/threadpool.py:250:inContext
/usr/lib64/python3.9/site-packages/twisted/python/threadpool.py:266:<lambda>
/usr/lib64/python3.9/site-packages/twisted/python/context.py:122:callWithContext
/usr/lib64/python3.9/site-packages/twisted/python/context.py:85:callWithContext
/usr/lib64/python3.9/site-packages/twisted/enterprise/adbapi.py:306:_runWithConnection
/usr/lib64/python3.9/site-packages/twisted/python/compat.py:464:reraise
/usr/lib64/python3.9/site-packages/twisted/enterprise/adbapi.py:297:_runWithConnection
/usr/lib/python3.9/site-packages/synapse/storage/database.py:739:inner_func
/usr/lib/python3.9/site-packages/synapse/storage/database.py:539:new_transaction
/usr/lib/python3.9/site-packages/synapse/logging/utils.py:71:wrapped
/usr/lib/python3.9/site-packages/synapse/storage/databases/main/events.py:379:_persist_events_txn
/usr/lib/python3.9/site-packages/synapse/storage/databases/main/events.py:472:_persist_event_auth_chain_txn
/usr/lib/python3.9/site-packages/synapse/storage/databases/main/events.py:630:_add_chain_cover_index
/usr/lib/python3.9/site-packages/synapse/storage/database.py:896:simple_insert_many_txn
/usr/lib/python3.9/site-packages/synapse/storage/database.py:274:execute_batch
/usr/lib/python3.9/site-packages/synapse/storage/database.py:319:_do_execute
/usr/lib/python3.9/site-packages/synapse/storage/database.py:274:<lambda>
/usr/lib64/python3.9/site-packages/psycopg2/extras.py:1209:execute_batch
]]

# Fixed code
def _purge_history_txn(
    self, txn, room_id: str, token: RoomStreamToken, delete_local_events: bool
) -> Set[int]:
    # Tables that should be pruned:
    #     event_auth
    #     event_backward_extremities
    #     event_edges
    #     event_forward_extremities
    #     event_json
    #     event_push_actions
    #     event_reference_hashes
    #     event_relations
    #     event_search
    #     event_to_state_groups
    #     events
    #     rejections
    #     room_depth
    #     state_groups
    #     state_groups_state
    #     destination_rooms

    # we will build a temporary table listing the events so that we don't
    # have to keep shovelling the list back and forth across the
    # connection. Annoyingly the python sqlite driver commits the
    # transaction on CREATE, so let's do this first.
    #
    # furthermore, we might already have the table from a previous (failed)
    # purge attempt, so let's drop the table first.

    txn.execute("DROP TABLE IF EXISTS events_to_purge")

    txn.execute(
        "CREATE TEMPORARY TABLE events_to_purge ("
        "    event_id TEXT NOT NULL,"
        "    should_delete BOOLEAN NOT NULL"
        ")"
    )

    # First ensure that we're not about to delete all the forward extremeties
    txn.execute(
        "SELECT e.event_id, e.depth FROM events as e "
        "INNER JOIN event_forward_extremities as f "
        "ON e.event_id = f.event_id "
        "AND e.room_id = f.room_id "
        "WHERE f.room_id = ?",
        (room_id,),
    )
    rows = txn.fetchall()
    max_depth = max(row[1] for row in rows)

    if max_depth < token.topological:
        # We need to ensure we don't delete all the events from the database
        # otherwise we wouldn't be able to send any events (due to not
        # having any backwards extremities)
        raise SynapseError(
            400, "topological_ordering is greater than forward extremeties"
        )

    logger.info("[purge] looking for events to delete")

    should_delete_expr = "state_key IS NULL"
    should_delete_params = ()  # type: Tuple[Any, ...]
    if not delete_local_events:
        should_delete_expr += " AND event_id NOT LIKE ?"

        # We include the parameter twice since we use the expression twice
        should_delete_params += ("%:" + self.hs.hostname, "%:" + self.hs.hostname)

    should_delete_params += (room_id, token.topological)

    # Note that we insert events that are outliers and aren't going to be
    # deleted, as nothing will happen to them.
    txn.execute(
        "INSERT INTO events_to_purge"
        " SELECT event_id, %s"
        " FROM events AS e LEFT JOIN state_events USING (event_id)"
        " WHERE (NOT outlier OR (%s)) AND e.room_id = ? AND topological_ordering < ?"
        % (should_delete_expr, should_delete_expr),
        should_delete_params,
    )

    # We create the indices *after* insertion as that's a lot faster.

    # create an index on should_delete because later we'll be looking for
    # the should_delete / shouldn't_delete subsets
    txn.execute(
        "CREATE INDEX events_to_purge_should_delete ON events_to_purge(should_delete)"
    )

    # We do joins against events_to_purge for e.g. calculating state
    # groups to purge, etc., so lets make an index.
    txn.execute("CREATE INDEX events_to_purge_id ON events_to_purge(event_id)")

    txn.execute("SELECT event_id, should_delete FROM events_to_purge")
    event_rows = txn.fetchall()
    logger.info(
        "[purge] found %i events before cutoff, of which %i can be deleted",
        len(event_rows),
        sum(1 for e in event_rows if e[1]),
    )

    logger.info("[purge] Finding new backward extremities")

    # We calculate the new entries for the backward extremities by finding
    # events to be purged that are pointed to by events we're not going to
    # purge.
    txn.execute(
        "SELECT DISTINCT e.event_id FROM events_to_purge AS e"
        " INNER JOIN event_edges AS ed ON e.event_id = ed.prev_event_id"
        " LEFT JOIN events_to_purge AS ep2 ON ed.event_id = ep2.event_id"
        " WHERE ep2.event_id IS NULL"
    )
    new_backwards_extrems = txn.fetchall()

    logger.info("[purge] replacing backward extremities: %r", new_backwards_extrems)

    txn.execute("DELETE FROM event_backward_extremities WHERE room_id = ?", (room_id,))

    # Update backward extremeties
    txn.execute_batch(
        "INSERT INTO event_backward_extremities (room_id, event_id) VALUES (?, ?)",
        [(room_id, event_id) for (event_id,) in new_backwards_extrems],
    )

    logger.info("[purge] finding state groups referenced by deleted events")

    # Get all state groups that are referenced by events that are to be
    # deleted.
    txn.execute(
        """
            SELECT DISTINCT state_group FROM events_to_purge
            INNER JOIN event_to_state_groups USING (event_id)
        """
    )

    referenced_state_groups = {sg for (sg,) in txn}
    logger.info(
        "[purge] found %i referenced state groups", len(referenced_state_groups)
    )

    logger.info("[purge] removing events from event_to_state_groups")
    txn.execute(
        "DELETE FROM event_to_state_groups "
        "WHERE event_id IN (SELECT event_id from events_to_purge)"
    )
    for event_id, _ in event_rows:
        txn.call_after(self._get_state_group_for_event.invalidate, (event_id,))

    # Delete all remote non-state events
    for table in (
        "events",
        "event_json",
        "event_auth",
        "event_edges",
        "event_forward_extremities",
        "event_reference_hashes",
        "event_relations",
        "event_search",
        "rejections",
    ):
        logger.info("[purge] removing events from %s", table)

        txn.execute(
            "DELETE FROM %s WHERE event_id IN ("
            "    SELECT event_id FROM events_to_purge WHERE should_delete"
            ")" % (table,)
        )

    # event_push_actions lacks an index on event_id, and has one on
    # (room_id, event_id) instead.
    for table in ("event_push_actions",):
        logger.info("[purge] removing events from %s", table)

        txn.execute(
            "DELETE FROM %s WHERE room_id = ? AND event_id IN ("
            "    SELECT event_id FROM events_to_purge WHERE should_delete"
            ")" % (table,),
            (room_id,),
        )

    # Mark all state and own events as outliers
    logger.info("[purge] marking remaining events as outliers")
    txn.execute(
        "UPDATE events SET outlier = ?"
        " WHERE event_id IN ("
        "    SELECT event_id FROM events_to_purge "
        "    WHERE NOT should_delete"
        ")",
        (True,),
    )

    # synapse tries to take out an exclusive lock on room_depth whenever it
    # persists events (because upsert), and once we run this update, we
    # will block that for the rest of our transaction.
    #
    # So, let's stick it at the end so that we don't block event
    # persistence.
    #
    # We do this by calculating the minimum depth of the backwards
    # extremities. However, the events in event_backward_extremities
    # are ones we don't have yet so we need to look at the events that
    # point to it via event_edges table.
    txn.execute(
        """
            SELECT COALESCE(MIN(depth), 0)
            FROM event_backward_extremities AS eb
            INNER JOIN event_edges AS eg ON eg.prev_event_id = eb.event_id
            INNER JOIN events AS e ON e.event_id = eg.event_id
            WHERE eb.room_id = ?
        """,
        (room_id,),
    )
    (min_depth,) = txn.fetchone()

    logger.info("[purge] updating room_depth to %d", min_depth)

    txn.execute(
        "UPDATE room_depth SET min_depth = ? WHERE room_id = ?",
        (min_depth, room_id),
    )

    # finally, drop the temp table. this will commit the txn in sqlite,
    # so make sure to keep this actually last.
    txn.execute("DROP TABLE events_to_purge")

    logger.info("[purge] done")

    return referenced_state_groups