Document that auth.deleteUsers() does not trigger auth.user().onDelete() in the docstring

Đang mở

#2,928 mở ngày 27/5/2025 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó: 1/5
Thời gian dự kiến: Dưới một giờ
Mức phù hợp với người mới: 55/100

Loại issue: Tài liệu
Độ rõ ràng: Đặc tả rõ ràng
Mức độ hoạt động: Đình trệ
Công nghệ: node.js, typescript
Lĩnh vực: documentation

Hướng nghiên cứu

Mở src/auth/base-auth.ts quanh các dòng 456-469 và đọc docstring của deleteUsers(), sau đó so sánh cách diễn đạt của nó với tài liệu Admin SDK được liên kết. Thêm một ghi chú rõ ràng rằng việc xóa hàng loạt không kích hoạt auth.user().onDelete() cho từng người dùng bị xóa; được xem là hoàn thành khi docstring của hàm và tài liệu tham chiếu API được tạo đều nêu cảnh báo này.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

api: auth

[REQUIRED] Step 2: Describe your environment

Operating System version: NA
Firebase SDK version: 13.4.0
Firebase Product: auth (node.js admin sdk)
Node.js version: 20
NPM version: NA

[REQUIRED] Step 3: Describe the problem

The deleteUsers() API does not trigger auth.user().onDelete() function calls for each individually deleted user.

This was unexpected for me, and the issue here is that this behavior was not documented in the place where I looked: the function docstring.

After https://github.com/firebase/firebase-functions/issues/860, I can see that this behavior was documented here https://firebase.google.com/docs/auth/admin/manage-users#delete_multiple_users

However, it is not documented on the actual function docstring: https://github.com/firebase/firebase-admin-node/blob/3c2cb9f0265ae836469198a7ff18d5454f18aefd/src/auth/base-auth.ts#L456-L469 (which is used to generate the API reference version at https://firebase.google.com/docs/reference/admin/node/firebase-admin.auth.baseauth#baseauthdeleteusers)

I would have preferred to see the same warning there, since this is what appears in IDEs when you may be poking around for a bulk version of deleteUser().

Ngôn ngữ chính: TypeScript
Star: 1.7k
Fork: 419
Merge trung bình: 4 ngày 20 giờ
Pull request đã merge (30 ngày): 16