microsoft / microsoft/azure-devops-python-api
Deleting Pull Request Attachments Prevents Reading Attachments
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 684
- Fork
- 218
- Merge trung bình
- 8 ngày 10 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
Hello,
I recently ran in to this issue while attempting to manage pull request attachments. It could be a bug with the AZDO API, but I'm specifically using azure-devops-python-api.
Steps to Reproduce
- Create multiple pull request attachments via
GitClient, and delete at least one. The specific order doesn't matter; you can create two attachments then delete one of them, or create a single attachment, delete it, and create a second attachment. - Attempting to access any non-deleted attachment (via the attachment URL) results in the following error:
{
"$id": "1",
"innerException": null,
"message": "TF400714: File ID 123456789 not found.",
"typeName": "Microsoft.TeamFoundation.Framework.Server.FileIdNotFoundException, Microsoft.TeamFoundation.Framework.Server",
"typeKey": "FileIdNotFoundException",
"errorCode": 0,
"eventId": 4005
}
Example Code
delete_attachment_bug.py
from azure.devops.v7_0.git.models import *
from azure.devops.v7_0.git.git_client import GitClient
from msrest.authentication import BasicAuthentication
from azure.devops.connection import Connection
from random import randint
import os
def fix_create_attachment(client: GitClient):
"""
See https://github.com/microsoft/azure-devops-python-api/issues/322 for documentation of this issue.
"""
def create_attachment(upload_stream, file_name, repository_id, pull_request_id, project=None):
route_values = {}
if project is not None:
route_values['project'] = client._serialize.url('project', project, 'str')
if file_name is not None:
route_values['fileName'] = client._serialize.url('file_name', file_name, 'str')
if repository_id is not None:
route_values['repositoryId'] = client._serialize.url('repository_id', repository_id, 'str')
if pull_request_id is not None:
route_values['pullRequestId'] = client._serialize.url('pull_request_id', pull_request_id, 'int')
# content = self._client.stream_upload(upload_stream, callback=callback)
response = client._send(http_method='POST',
location_id='965d9361-878b-413b-a494-45d5b5fd8ab7',
version='7.0',
route_values=route_values,
content=upload_stream.read(),
media_type='application/octet-stream')
return client._deserialize('Attachment', response)
client.create_attachment = create_attachment
pat = os.environ.get("mypersonalaccesstoken")
auth = BasicAuthentication("", pat)
connection = Connection("https://dev.azure.com/someorganization/", auth)
client: GitClient = connection.clients.get_git_client()
fix_create_attachment(client)
pr_id = 123456
project_id = "MyProject"
repo_id = "MyRepo"
def create_attachment():
with open("cool_pic.png", "rb") as file:
# Create random name for attachment
name = f"{randint(0,10000)}.png"
attachment: Attachment = client.create_attachment(file, name, repo_id, pr_id, project_id)
print(f"Created attachment: {name}\n(URL: {attachment.url})")
def delete_attachment(name):
client.delete_attachment(name, repo_id, pr_id, project_id)
print(f"Deleted attachment: {name}")
This code can be used along with the Python shell to reproduce the issue:
python -i delete_attachment_bug.py
>>> create_attachment()
>>> delete_attachment("nameFromPreviousCall")
>>> create_attachment()
Trying to access the most recently created attachment (via the attachment URL) results in the above error.
I'm using Python 3.7.4 and azure-devops==7.1.0b4.
I haven't been able to find a workaround yet. Note the example code includes a workaround for #322.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu với delete_attachment_bug.py và các lệnh gọi GitClient create_attachment và delete_attachment, sau đó tái hiện chuỗi này trong Python shell. So sánh các request và các attachment URL được trả về sau khi xóa để xác định liệu client hay Azure DevOps API gây ra FileIdNotFoundException. Hoàn tất khi nguyên nhân đã được xác định và các attachment không bị xóa vẫn có thể đọc được sau chuỗi này.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- azure, devops, python
- Lĩnh vực
- api, devops
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100