🐛 [delete-user-data] Not all data is deleted

[filipre]

[REQUIRED] Step 2: Describe your configuration

• Extension name: delete-user-data (storage-resize-images, firestore-send-email, etc)
• Extension version: 0.1.29
• Configuration values (redact info where appropriate):
  • Cloud Firestore paths: empty
  • Cloud Firestore delete mode: recursive
  • Enable auto discovery: yes
  • Auto discovery search depth: 3
  • Auto discovery search fields (Optional): uid,userId,creatorId,scope.owner.id

[REQUIRED] Step 3: Describe the problem

Hi!

It looks like the extension has the implicit assumption that every document key contains a user ID but that may not always be the case. Or the auto discovery is not being applied. For example, consider a table "session" that has userId as a property but uses keys like session/<session ID>. Looking at the current documentation and implementation, it seems like it is not possible to delete document for session

Case 1: Cloud Firestore paths is empty -> Enable auto discovery is not being applied
Case 2: Cloud Firestore paths is set to sessions -> This will remove all sessions according to the current code I believe:

  const paths = extractUserPaths(databasePaths, uid);
  const promises = paths.map(async (path) => {
    try {
      logs.rtdbPathDeleting(path);
      await admin.database().ref(path).remove(); // <-- Deletes whole table, we don't want that
      logs.rtdbPathDeleted(path);
    } catch (err) {
      logs.rtdbPathError(path, err);
    }
  });

Case 3: Cloud Firestore paths is set to sessions/{UID} -> This will not work because the UID is not part of the key.

Are my assumptions correct or is it somehow possible to delete session with the current version? If not, I'd say it's a bug that the auto discovery isn't applied. Or is the issue that properties like A.B.C are not being resolved? What happens if the key is inside an object within the document?

Thanks a lot!

Steps to reproduce:

See above

Expected result

I'd expect that the auto discovery finds the documents in Case 1 and deletes it.

Actual result

Documents are not being deleted.

[cabljac]

Hey, thanks for raising this! It's being tracked and we'll get back to you with updates

[IzaakGough]

Hey @filipre, thanks for the detailed write-up!

I've tested this with the same extension version (0.1.29) and your exact configuration, sessions keyed by session ID with a userId field and the documents were deleted correctly on user deletion.

Auto discovery runs independently of whether Firestore paths is set, so your current config should already be working. Are you actually seeing documents not being deleted, or was this based on reading the code?

[filipre]

Thanks for the reply!

I didn't test case 2 (because I was afraid my whole sessions collection might get deleted) but I did test case 1 and 3. So what you are saying is that auto discovery should have ran even when the Cloud Firestore paths field was empty? For me, the collections haven't been deleted in our setup and I also didn't see any logs indicating that they should have been deleted. Actually, our user keys look more like scope.owner.id so there is a scope property inside the document that contains a nested object. Firebase allows me to query for those user ids using the "dot" syntax but maybe the extension doesn't support this?

[IzaakGough]

Ah I see, so is your data structured more like this?

{
  "sessions": {
    "session_1": {
      "scope": {
        "owner": {
          "id": "uid_example"
        }
      }
    }
  }
}

If so, then yes I believe the extension doesn't currently support nested field paths in searchFields. It's a great feature request though, and the fix would be relatively straightforward. We'll look into it!

[filipre]

Yes! This must be the reason then why deletion didn't work. Just for clarity, our stucture looks more like this below but I think we mean the same thing. It's not a single document but each session has it's own document in Firestore:

Document 1 session/session_123

{
  "some": "data"
  "scope": {"owner": {"id": "some_uid"}}
}

Document 2 session/session_456

{
  "some": "data"
  "scope": {"owner": {"id": "some_uid"}}
}