Changeset 7d8d744 in trunk

Timestamp:

2019-02-26T19:26:37Z (6 years ago)

Author:

Jean-Paul Calderone <exarkun@…>

Branches:

master

Children:

9244956

Parents:

248449f

Message:

Convert Downloader._process

File:

• src/allmydata/frontends/magic_folder.py (modified) (6 diffs)

src/allmydata/frontends/magic_folder.py ¶

@@ -813 +813 @@
 )
 
+_STATUS = Field.for_types(
+    u"status",
+    # Should just be unicode...
+    [unicode, bytes],
+    u"The status of an item in a processing queue.",
+)
+
+QUEUED_ITEM_STATUS_CHANGE = MessageType(
+    u"magic-folder:item:status-change",
+    [eliotutil.RELPATH, _STATUS],
+    u"A queued item changed status.",
+)
+
+_CONFLICT_REASON = Field.for_types(
+    u"conflict_reason",
+    [unicode, type(None)],
+    u"A human-readable explanation of why a file was in conflict.",
+    eliotutil.validateSetMembership({
+        u"dbentry mismatch metadata",
+        u"dbentry newer version",
+        u"last_downloaded_uri mismatch",
+        u"file appeared",
+    }),
+)
+
+CHECKING_CONFLICTS = ActionType(
+    u"magic-folder:item:checking-conflicts",
+    [],
+    [_IS_CONFLICT, _CONFLICT_REASON],
+    u"A potential download item is being checked to determine if it is in a conflicted state.",
+)
+
+REMOTE_DIRECTORY_CREATED = MessageType(
+    u"magic-folder:remote-directory-created",
+    [],
+    u"The downloader found a new directory in the DMD.",
+)
+
+REMOTE_DIRECTORY_DELETED = MessageType(
+    u"magic-folder:remote-directory-deleted",
+    [],
+    u"The downloader found a directory has been deleted from the DMD.",
+)
+
 class QueueMixin(HookMixin):
     """
@@ -1025 +1069 @@
             current_time = time.time()
         self._status_history[status] = current_time
+        QUEUED_ITEM_STATUS_CHANGE.log(
+            relpath=self.relpath_u,
+            status=status,
+        )
 
     def status_time(self, state):
@@ -1751 +1799 @@
                     self._count("objects_queued")
                 else:
-                    self._log("Excluding %r" % (relpath_u,))
                     self._call_hook(None, 'processed', async=True)  # await this maybe-Deferred??
 
-            self._log("deque after = %r" % (self._deque,))
         d.addCallback(_filter_batch_to_deque)
         return d.addActionFinish()
@@ -1852 +1898 @@
             #     uploaded.
 
-            if db_entry:
-                # * 2c. If any of the following are true, then classify as a conflict:
-                #   * i. there are pending notifications of changes to ``foo``;
-                #   * ii. the last-seen statinfo is either absent (i.e. there is
-                #     no entry in the database for this path), or different from the
-                #     current statinfo;
-
-                if current_statinfo.exists:
-                    self._log("checking conflicts {}".format(item.relpath_u))
-                    if (db_entry.mtime_ns != current_statinfo.mtime_ns or \
-                        db_entry.ctime_ns != current_statinfo.ctime_ns or \
-                        db_entry.size != current_statinfo.size):
+            with CHECKING_CONFLICTS() as action:
+                if db_entry:
+                    # * 2c. If any of the following are true, then classify as a conflict:
+                    #   * i. there are pending notifications of changes to ``foo``;
+                    #   * ii. the last-seen statinfo is either absent (i.e. there is
+                    #     no entry in the database for this path), or different from the
+                    #     current statinfo;
+
+                    if current_statinfo.exists:
+                        conflict_reason = None
+                        if (db_entry.mtime_ns != current_statinfo.mtime_ns or \
+                            db_entry.ctime_ns != current_statinfo.ctime_ns or \
+                            db_entry.size != current_statinfo.size):
+                            is_conflict = True
+                            conflict_reason = u"dbentry mismatch metadata"
+
+                        if db_entry.last_downloaded_uri is None \
+                           or db_entry.last_uploaded_uri is None \
+                           or dmd_last_downloaded_uri is None:
+                            # we've never downloaded anything before for this
+                            # file, but the other side might have created a new
+                            # file "at the same time"
+                            if db_entry.version >= item.metadata['version']:
+                                is_conflict = True
+                                conflict_reason = u"dbentry newer version"
+                        elif dmd_last_downloaded_uri != db_entry.last_downloaded_uri:
+                            is_conflict = True
+                            conflict_reason = u"last_downloaded_uri mismatch"
+
+                else:  # no local db_entry .. but has the file appeared locally meantime?
+                    if current_statinfo.exists:
                         is_conflict = True
-                        self._log("conflict because local change0")
-
-                    if db_entry.last_downloaded_uri is None \
-                       or db_entry.last_uploaded_uri is None \
-                       or dmd_last_downloaded_uri is None:
-                        # we've never downloaded anything before for this
-                        # file, but the other side might have created a new
-                        # file "at the same time"
-                        if db_entry.version >= item.metadata['version']:
-                            self._log("conflict because my version >= remote version")
-                            is_conflict = True
-                    elif dmd_last_downloaded_uri != db_entry.last_downloaded_uri:
-                        is_conflict = True
-                        self._log("conflict because dmd_last_downloaded_uri != db_entry.last_downloaded_uri")
-
-            else:  # no local db_entry .. but has the file appeared locally meantime?
-                if current_statinfo.exists:
-                    is_conflict = True
-                    self._log("conflict because local change1")
+                        conflict_reason = u"file appeared"
+
+                action.add_success_fields(
+                    is_conflict=is_conflict,
+                    conflict_reason=conflict_reason,
+                )
 
             if is_conflict:
@@ -1890 +1942 @@
             if item.relpath_u.endswith(u"/"):
                 if item.metadata.get('deleted', False):
-                    self._log("rmdir(%r) ignored" % (abspath_u,))
+                    REMOTE_DIRECTORY_DELETED.log()
                 else:
-                    self._log("mkdir(%r)" % (abspath_u,))
+                    REMOTE_DIRECTORY_CREATED.log()
                     d.addCallback(lambda ign: fileutil.make_dirs(abspath_u))
                     d.addCallback(lambda ign: abspath_u)
@@ -1913 +1965 @@
         def trap_conflicts(f):
             f.trap(ConflictError)
-            self._log("IGNORE CONFLICT ERROR %r" % f)
             return False
         d.addErrback(trap_conflicts)