microsoft / microsoft/azure-devops-python-api
Deleting Pull Request Attachments Prevents Reading Attachments
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 684
- フォーク
- 218
- 平均マージ
- 8日 10時間
- マージ済み PR(30日)
- 1
説明
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.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
delete_attachment_bug.py と GitClient の create_attachment および delete_attachment の呼び出しから始め、次に Python shell でそのシーケンスを再現します。削除後のリクエストと返された attachment URL を比較し、FileIdNotFoundException の原因がクライアントと Azure DevOps API のどちらにあるのかを特定します。原因が確定し、そのシーケンス後も削除されていない attachment が読み取り可能なままであれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- azure, devops, python
- 領域
- api, devops
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100