CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Downloader] Catch and handle erorr in update_all when target repository/branch is missing (#3080)

Browse Source 
* [Downloader] Catch and handle erorr in update_all when target repository/branch is removed from remote

* Rewrite fix, remove ctx from repo_manager, edit docstring, add annotations

* Text formatting

* Group failed repo messages into padded table, catch single updated repo fails

* Error catching v2; repo_manager design change

* Docstrings, typos and changelog

* Add Optional to update_repos annotatition

* Wrong logic

* Clear-er log message.

* add format_failed_repos, change _repo_update for failed messages

* Merge cog updating with fail repo logic; Filter out failed repos

* Merge cog updating with fail repo logic; Cog updating logic shuffled to support sending fails at the end

* Docstring typo

* format_failed_repos - proper docstring

* repo_manager.update_repos argument name fix

* downloader._cog_checkforupdates added missed failed message

* downloader._cog_update_logic place back return on some errors

* Purge unused stuff from downloader._repo_update

* downloader._cog_update_logic Change exception catching

* _cog_update_logic purging obsolete

* Remove obsolete 'message' from _cog_checkforupdates

* Fix forgotten ctx.send

* Wording

* Removed obsolete 'message'

* Fix wrong type hint in , update docstring

* repo update logic fix

* format_failed_repos type hint and docstring repair

* Extend _get_cogs_to_check with 'update_repos'

* Fix type mangling in _get_cogs_to_check

* fix: typo

Co-Authored-By: jack1142 <6032823+jack1142@users.noreply.github.com>

* _repo_update; Added single repo up-to-date message
This commit is contained in:
Tomas S 2019-12-08 23:59:53 +01:00 committed by Michael H
parent 9a051ef2c6
commit 064d97f87b
5 changed files with 178 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/downloader/2936.bugfix.rst Normal file
View File

@ -0,0 +1 @@
Catch errors if remote repository or branch is deleted, notify user which repository failed and continue updating others.

1
changelog.d/downloader/3080.misc.1.rst Normal file
View File

@ -0,0 +1 @@
`RepoManager.update_all_repos` replaced by new method `update_repos` which additionally handles failing repositories.

1
changelog.d/downloader/3080.misc.2.rst Normal file
View File

@ -0,0 +1 @@
Added `Downloader.format_failed_repos` for formatting error message of repos failing to update.

152
redbot/cogs/downloader/downloader.py
View File

@ -5,7 +5,7 @@ import re
import shutil
import sys
from pathlib import Path
from typing import Tuple, Union, Iterable, Optional, Dict, Set, List, cast
from typing import Tuple, Union, Iterable, Collection, Optional, Dict, Set, List, cast
from collections import defaultdict
import discord
@ -499,24 +499,24 @@ class Downloader(commands.Cog):
"""Update all repos, or ones of your choosing."""
async with ctx.typing():
updated: Set[str]
if not repos:
updated = {repo.name for repo in await self._repo_manager.update_all_repos()}
else:
updated = set()
for repo in repos:
old, new = await repo.update()
if old != new:
updated.add(repo.name)
updated_repos, failed = await self._repo_manager.update_repos(repos)
updated = {repo.name for repo in updated_repos}
if updated:
message = _("Repo update completed successfully.")
message += _("\nUpdated: ") + humanize_list(tuple(map(inline, updated)))
elif repos is None:
await ctx.send(_("All installed repos are already up to date."))
return
elif not repos:
message = _("All installed repos are already up to date.")
else:
await ctx.send(_("These repos are already up to date."))
return
if len(updated_repos) > 1:
message = _("These repos are already up to date.")
else:
message = _("This repo is already up to date.")
if failed:
message += "\n" + self.format_failed_repos(failed)
await ctx.send(message)
@commands.group()
@ -721,8 +721,9 @@ class Downloader(commands.Cog):
This command doesn't update cogs, it only checks for updates.
Use `[p]cog update` to update cogs.
"""
async with ctx.typing():
cogs_to_check = await self._get_cogs_to_check()
cogs_to_check, failed = await self._get_cogs_to_check()
cogs_to_update, libs_to_update = await self._available_updates(cogs_to_check)
message = ""
if cogs_to_update:
@ -735,10 +736,14 @@ class Downloader(commands.Cog):
message += _("\nThese shared libraries can be updated: ") + humanize_list(
tuple(map(inline, libnames))
)
if message:
if not message:
message = _("All installed cogs are up to date.")
if failed:
message += "\n" + self.format_failed_repos(failed)
await ctx.send(message)
else:
await ctx.send(_("All installed cogs are up to date."))
@cog.command(name="update")
async def _cog_update(self, ctx: commands.Context, *cogs: InstalledCog) -> None:
@ -774,11 +779,22 @@ class Downloader(commands.Cog):
rev: Optional[str] = None,
cogs: Optional[List[InstalledModule]] = None,
) -> None:
message = ""
failed_repos = set()
updates_available = set()
async with ctx.typing():
# this is enough to be sure that `rev` is not None (based on calls to this method)
if repo is not None:
rev = cast(str, rev)
try:
await repo.update()
except errors.UpdateError:
message = self.format_failed_repos([repo.name])
await ctx.send(message)
return
try:
commit = await repo.get_full_sha1(rev)
except errors.AmbiguousRevision as e:
@ -794,52 +810,57 @@ class Downloader(commands.Cog):
await ctx.send(msg)
return
except errors.UnknownRevision:
await ctx.send(
_("Error: there is no revision `{rev}` in repo `{repo.name}`").format(
rev=rev, repo=repo
)
)
message += _(
"Error: there is no revision `{rev}` in repo `{repo.name}`"
).format(rev=rev, repo=repo)
await ctx.send(message)
return
await repo.checkout(commit)
cogs_to_check = await self._get_cogs_to_check(repos=[repo], cogs=cogs)
cogs_to_check, __ = await self._get_cogs_to_check(
repos=[repo], cogs=cogs, update_repos=False
)
else:
cogs_to_check = await self._get_cogs_to_check(repos=repos, cogs=cogs)
cogs_to_check, check_failed = await self._get_cogs_to_check(repos=repos, cogs=cogs)
failed_repos.update(check_failed)
pinned_cogs = {cog for cog in cogs_to_check if cog.pinned}
cogs_to_check -= pinned_cogs
if not cogs_to_check:
message = _("There were no cogs to check.")
message += _("There were no cogs to check.")
if pinned_cogs:
cognames = [cog.name for cog in pinned_cogs]
message += _(
"\nThese cogs are pinned and therefore weren't checked: "
) + humanize_list(tuple(map(inline, cognames)))
await ctx.send(message)
return
else:
cogs_to_update, libs_to_update = await self._available_updates(cogs_to_check)
updates_available = cogs_to_update or libs_to_update
cogs_to_update, filter_message = self._filter_incorrect_cogs(cogs_to_update)
message = ""
if updates_available:
updated_cognames, message = await self._update_cogs_and_libs(
cogs_to_update, libs_to_update
)
else:
if repos:
message = _("Cogs from provided repos are already up to date.")
message += _("Cogs from provided repos are already up to date.")
elif repo:
if cogs:
message = _("Provided cogs are already up to date with this revision.")
message += _(
"Provided cogs are already up to date with this revision."
)
else:
message = _(
message += _(
"Cogs from provided repo are already up to date with this revision."
)
else:
if cogs:
message = _("Provided cogs are already up to date.")
message += _("Provided cogs are already up to date.")
else:
message = _("All installed cogs are already up to date.")
message += _("All installed cogs are already up to date.")
if repo is not None:
await repo.checkout(repo.branch)
if pinned_cogs:
@ -848,7 +869,12 @@ class Downloader(commands.Cog):
"\nThese cogs are pinned and therefore weren't checked: "
) + humanize_list(tuple(map(inline, cognames)))
message += filter_message
if failed_repos:
message += "\n" + self.format_failed_repos(failed_repos)
await ctx.send(message)
if updates_available and updated_cognames:
await self._ask_for_cog_reload(ctx, updated_cognames)
@ -1024,23 +1050,31 @@ class Downloader(commands.Cog):
*,
repos: Optional[Iterable[Repo]] = None,
cogs: Optional[Iterable[InstalledModule]] = None,
) -> Set[InstalledModule]:
update_repos: bool = True,
) -> Tuple[Set[InstalledModule], List[str]]:
failed = []
if not (cogs or repos):
await self._repo_manager.update_all_repos()
cogs_to_check = {cog for cog in await self.installed_cogs() if cog.repo is not None}
if update_repos:
__, failed = await self._repo_manager.update_repos()
cogs_to_check = {
cog
for cog in await self.installed_cogs()
if cog.repo is not None and cog.repo.name not in failed
}
else:
# this is enough to be sure that `cogs` is not None (based on if above)
if not repos:
cogs = cast(Iterable[InstalledModule], cogs)
repos = {cog.repo for cog in cogs if cog.repo is not None}
for repo in repos:
if await repo.is_on_branch():
exit_to_commit = None
else:
exit_to_commit = repo.commit
await repo.update()
await repo.checkout(exit_to_commit)
if update_repos:
__, failed = await self._repo_manager.update_repos(repos)
if failed:
# remove failed repos
repos = {repo for repo in repos if repo.name not in failed}
if cogs:
cogs_to_check = {cog for cog in cogs if cog.repo is not None and cog.repo in repos}
else:
@ -1050,7 +1084,7 @@ class Downloader(commands.Cog):
if cog.repo is not None and cog.repo in repos
}
return cogs_to_check
return (cogs_to_check, failed)
async def _update_cogs_and_libs(
self, cogs_to_update: Iterable[Installable], libs_to_update: Iterable[Installable]
@ -1207,3 +1241,31 @@ class Downloader(commands.Cog):
msg = _("This command is not provided by a cog.")
await ctx.send(box(msg))
@staticmethod
def format_failed_repos(failed: Collection[str]) -> str:
"""Format collection of ``Repo.name``'s into failed message.
Parameters
----------
failed : Collection
Collection of ``Repo.name``
Returns
-------
str
formatted message
"""
message = (
_("Failed to update the following repositories:")
if len(failed) > 1
else _("Failed to update the following repository:")
)
message += " " + humanize_list(tuple(map(inline, failed))) + "\n"
message += _(
"The repository's branch might have been removed or"
" the repository is no longer accessible at set url."
" See logs for more information."
)
return message

49
redbot/cogs/downloader/repo_manager.py
View File

@ -796,6 +796,9 @@ class Repo(RepoJSONMixin):
`tuple` of `str`
:py:code`(old commit hash, new commit hash)`
Raises
-------
`UpdateError` - if git pull results with non-zero exit code
"""
old_commit = await self.latest_commit()
@ -1134,28 +1137,58 @@ class RepoManager:
Tuple[Repo, Tuple[str, str]]
A 2-`tuple` with Repo object and a 2-`tuple` of `str`
containing old and new commit hashes.
"""
repo = self._repos[repo_name]
old, new = await repo.update()
return (repo, (old, new))
async def update_all_repos(self) -> Dict[Repo, Tuple[str, str]]:
"""Call `Repo.update` on all repositories.
async def update_repos(
self, repos: Optional[Iterable[Repo]] = None
) -> Tuple[Dict[Repo, Tuple[str, str]], List[str]]:
"""Calls `Repo.update` on passed repositories and
catches failing ones.
Calling without params updates all currently installed repos.
Parameters
----------
repos: Iterable
Iterable of Repos, None to update all
Returns
-------
Dict[Repo, Tuple[str, str]]
tuple of Dict and list
A mapping of `Repo` objects that received new commits to
a 2-`tuple` of `str` containing old and new commit hashes.
`list` of failed `Repo` names
"""
failed = []
ret = {}
for repo_name, __ in self._repos.items():
repo, (old, new) = await self.update_repo(repo_name)
# select all repos if not specified
if not repos:
repos = self.repos
for repo in repos:
try:
updated_repo, (old, new) = await self.update_repo(repo.name)
except errors.UpdateError as err:
log.error(
"Repository '%s' failed to update. URL: '%s' on branch '%s'",
repo.name,
repo.url,
repo.branch,
exc_info=err,
)
failed.append(repo.name)
continue
if old != new:
ret[repo] = (old, new)
return ret
ret[updated_repo] = (old, new)
return ret, failed
async def _load_repos(self, set_repos: bool = False) -> Dict[str, Repo]:
ret = {}