From 7c98684c7f6f6e932579e2ada2fe099374deca22 Mon Sep 17 00:00:00 2001
From: "bodong.yang" <bodong.yang@tier4.jp>
Date: Wed, 25 Dec 2024 04:01:22 +0000
Subject: [PATCH] file_table: use burst_suppressed_logger to log failed file op

---
 src/ota_metadata/file_table/_table.py | 112 +++++++++++++++-----------
 1 file changed, 63 insertions(+), 49 deletions(-)

diff --git a/src/ota_metadata/file_table/_table.py b/src/ota_metadata/file_table/_table.py
index 2a7a664f3..43df6d3a7 100644
--- a/src/ota_metadata/file_table/_table.py
+++ b/src/ota_metadata/file_table/_table.py
@@ -27,8 +27,11 @@
 from typing_extensions import Annotated
 
 from ota_metadata.file_table._types import EntryAttrsType
+from otaclient_common.logging import get_burst_suppressed_logger
 from otaclient_common.typing import StrOrPath
 
+burst_suppressed_logger = get_burst_suppressed_logger(f"{__name__}.file_op_failed")
+
 CANONICAL_ROOT = "/"
 
 
@@ -110,28 +113,33 @@ def prepare_target(
         target_mnt: StrOrPath,
         prepare_method: Literal["move", "hardlink", "copy"],
     ) -> None:
-        _target_on_mnt = self.fpath_on_target(target_mnt=target_mnt)
-
-        if prepare_method == "copy":
-            shutil.copy(_rs, _target_on_mnt)
-            self.set_perm(_target_on_mnt)
-            self.set_xattr(_target_on_mnt)
-            return
-
-        if prepare_method == "hardlink":
-            # NOTE: os.link will make dst a hardlink to src.
-            os.link(_rs, _target_on_mnt)
-            # NOTE: although we actually don't need to set_perm and set_xattr everytime
-            #   to file paths point to the same inode, for simplicity here we just
-            #   do it everytime.
-            self.set_perm(_target_on_mnt)
-            self.set_xattr(_target_on_mnt)
-            return
-
-        if prepare_method == "move":
-            shutil.move(str(_rs), _target_on_mnt)
-            self.set_perm(_target_on_mnt)
-            self.set_xattr(_target_on_mnt)
+        try:
+            _target_on_mnt = self.fpath_on_target(target_mnt=target_mnt)
+
+            if prepare_method == "copy":
+                shutil.copy(_rs, _target_on_mnt)
+                self.set_perm(_target_on_mnt)
+                self.set_xattr(_target_on_mnt)
+                return
+
+            if prepare_method == "hardlink":
+                # NOTE: os.link will make dst a hardlink to src.
+                os.link(_rs, _target_on_mnt)
+                # NOTE: although we actually don't need to set_perm and set_xattr everytime
+                #   to file paths point to the same inode, for simplicity here we just
+                #   do it everytime.
+                self.set_perm(_target_on_mnt)
+                self.set_xattr(_target_on_mnt)
+                return
+
+            if prepare_method == "move":
+                shutil.move(str(_rs), _target_on_mnt)
+                self.set_perm(_target_on_mnt)
+                self.set_xattr(_target_on_mnt)
+        except Exception as e:
+            burst_suppressed_logger.exception(
+                f"failed on preparing {self}, {_rs=}: {e!r}"
+            )
 
 
 class FileTableNonRegularFiles(TableSpec, FileTableBase):
@@ -170,36 +178,42 @@ def set_perm(self, _target: StrOrPath) -> None:
             os.chmod(_target, mode=entry_attrs.mode)
 
     def prepare_target(self, *, target_mnt: StrOrPath) -> None:
-        _target_on_mnt = self.fpath_on_target(target_mnt=target_mnt)
-
-        entry_attrs = self.entry_attrs
-        _mode = entry_attrs.mode
-        if stat.S_ISLNK(_mode):
-            assert (
-                _symlink_target_raw := self.contents
-            ), f"invalid entry {self}, entry is a symlink but no link target is defined"
-
-            _symlink_target = _symlink_target_raw.decode()
-            _target_on_mnt.symlink_to(_symlink_target)
-            self.set_perm(_target_on_mnt)
-            self.set_xattr(_target_on_mnt)
-            return
-
-        if stat.S_ISCHR(_mode):
-            _device_num = os.makedev(0, 0)
-            os.mknod(_target_on_mnt, mode=_mode, device=_device_num)
-            self.set_perm(_target_on_mnt)
-            self.set_xattr(_target_on_mnt)
-            return
-
-        raise ValueError(f"invalid entry {self}")
+        try:
+            _target_on_mnt = self.fpath_on_target(target_mnt=target_mnt)
+
+            entry_attrs = self.entry_attrs
+            _mode = entry_attrs.mode
+            if stat.S_ISLNK(_mode):
+                assert (
+                    _symlink_target_raw := self.contents
+                ), f"invalid entry {self}, entry is a symlink but no link target is defined"
+
+                _symlink_target = _symlink_target_raw.decode()
+                _target_on_mnt.symlink_to(_symlink_target)
+                self.set_perm(_target_on_mnt)
+                self.set_xattr(_target_on_mnt)
+                return
+
+            if stat.S_ISCHR(_mode):
+                _device_num = os.makedev(0, 0)
+                os.mknod(_target_on_mnt, mode=_mode, device=_device_num)
+                self.set_perm(_target_on_mnt)
+                self.set_xattr(_target_on_mnt)
+                return
+
+            raise ValueError(f"invalid entry {self}")
+        except Exception as e:
+            burst_suppressed_logger.exception(f"failed on preparing {self}: {e!r}")
 
 
 class FileTableDirectories(TableSpec, FileTableBase):
     """DB table for directory entries."""
 
     def prepare_target(self, *, target_mnt: StrOrPath) -> None:
-        _target_on_mnt = self.fpath_on_target(target_mnt=target_mnt)
-        _target_on_mnt.mkdir(exist_ok=True, parents=True)
-        self.set_perm(_target_on_mnt)
-        self.set_xattr(_target_on_mnt)
+        try:
+            _target_on_mnt = self.fpath_on_target(target_mnt=target_mnt)
+            _target_on_mnt.mkdir(exist_ok=True, parents=True)
+            self.set_perm(_target_on_mnt)
+            self.set_xattr(_target_on_mnt)
+        except Exception as e:
+            burst_suppressed_logger.exception(f"failed on preparing {self}: {e!r}")