* fix most of grammar errors in comments

n0099 · n0099 · commit 56e93b4bad3a · 2024-03-24T15:43:05.000+08:00
* fix more violations of ReSharper inspections
* add two common proper nouns in `UserDictionary` @ tbm.sln.DotSettings
@ c#
diff --git a/c#/crawler/src/Tieba/Crawl/CrawlPost.cs b/c#/crawler/src/Tieba/Crawl/CrawlPost.cs
@@ -128,6 +128,8 @@ await Task.WhenAll(shouldCrawlParentPosts.Select(async t =>
     }
 
     private Action<Exception> SaveThreadMissingFirstReply
+
+        // ReSharper disable once SuggestBaseTypeForParameter
         (Fid fid, Tid tid, SavedThreadsList savedThreads) => ex =>
     {
         if (ex is not EmptyPostListException) return;
diff --git a/c#/crawler/src/Tieba/Crawl/Crawler/ThreadArchiveCrawler.cs b/c#/crawler/src/Tieba/Crawl/Crawler/ThreadArchiveCrawler.cs
@@ -11,7 +11,7 @@ protected override IEnumerable<Request> GetRequestsForPage(Page page, Cancellati
             (req, common) => req.Data.Common = common,
             () => new ThreadResponse(), stoppingToken);
         return
-        [ // passing CrawlRequestFlag.ThreadClientVersion602 in the second one in order to invokes ThreadParser.ShouldSkipParse()
+        [ // passing CrawlRequestFlag.ThreadClientVersion602 in the second one in order to invoke ThreadParser.ShouldSkipParse()
             new(response),
             new(response, CrawlRequestFlag.ThreadClientVersion602)
         ];
diff --git a/c#/crawler/src/Tieba/Crawl/Facade/BaseCrawlFacade.cs b/c#/crawler/src/Tieba/Crawl/Facade/BaseCrawlFacade.cs
@@ -81,6 +81,7 @@ public async Task<BaseCrawlFacade<TPost, TBaseRevision, TResponse, TPostProtoBuf
             endPage = Math.Min(endPage, maxPage ?? Page.MaxValue);
         }, startPage, previousFailureCount: 0, stoppingToken);
 
+        // ReSharper disable once InvertIf
         if (!isStartPageCrawlFailed)
         {
             var pagesAfterStart = Enumerable.Range(
diff --git a/c#/crawler/src/Tieba/Crawl/Facade/ReplyCrawlFacade.cs b/c#/crawler/src/Tieba/Crawl/Facade/ReplyCrawlFacade.cs
@@ -50,7 +50,7 @@ from t in db.Threads.AsNoTracking().ForUpdate()
             where t.Tid == tid
             select t.Title).SingleOrDefault();
 
-        // thread title will be empty string as a fallback when the thread author haven't write title for this thread
+        // thread title will be empty string as a fallback when the thread author haven't written title for this thread
         if (parentThreadTitle != "") return;
         var newTitle = replies.FirstOrDefault(r => r.Floor == 1)?.Title;
         if (newTitle == null) return;
diff --git a/c#/crawler/src/Tieba/Crawl/Facade/ThreadCrawlFacade.cs b/c#/crawler/src/Tieba/Crawl/Facade/ThreadCrawlFacade.cs
@@ -43,7 +43,7 @@ protected void ParseLatestRepliers(IEnumerable<Thread> threads) =>
             .OfType<TbClient.User>() // filter out nulls
 
             // some rare deleted thread but still visible in 6.0.2 response
-            // will have a latest replier uid=0 name="" nameShow=".*"
+            // will have the latest replier uid=0 name="" nameShow=".*"
             .Where(u => u.Uid != 0)
             .Select(u => User.CreateLatestReplier(u.Uid, u.Name.NullIfEmpty(),
                 u.Name == u.NameShow ? null : u.NameShow))
diff --git a/c#/crawler/src/Tieba/Crawl/Parser/BaseParser.cs b/c#/crawler/src/Tieba/Crawl/Parser/BaseParser.cs
@@ -23,8 +23,9 @@ public void ParsePosts(
             .Where(u => u.CalculateSize() != 0)); // remove empty users
     }
 
-    protected abstract PostId PostIdSelector(TPost post);
+    // ReSharper disable once UnusedMemberInSuper.Global
     protected abstract TPost Convert(TPostProtoBuf inPost);
     protected abstract IEnumerable<TPost> ParsePostsInternal(IList<TPostProtoBuf> inPosts, List<TbClient.User?> outUsers);
     protected virtual bool ShouldSkipParse(CrawlRequestFlag requestFlag) => false;
+    protected abstract PostId PostIdSelector(TPost post);
 }
diff --git a/c#/crawler/src/Tieba/Crawl/Parser/ReplyParser.cs b/c#/crawler/src/Tieba/Crawl/Parser/ReplyParser.cs
@@ -48,10 +48,10 @@ protected override ReplyPost Convert(Reply inPost)
             o.Content = Helper.SerializedProtoBufWrapperOrNullIfEmpty(inPost.Content,
                 () => Helper.WrapPostContent(inPost.Content));
 
-            // AuthorId rarely respond with 0, Author should always be null but we can guarantee
+            // AuthorId rarely respond with 0, Author should always be null with no guarantee
             o.AuthorUid = inPost.AuthorId.NullIfZero() ?? inPost.Author?.Uid ?? 0;
 
-            // value of AuthorExpGrade will be write back in ReplyCrawlFacade.FillAuthorInfoBackToReply()
+            // value of AuthorExpGrade will be written back in ReplyCrawlFacade.FillAuthorInfoBackToReply()
             o.SubReplyCount = inPost.SubPostNumber.NullIfZero();
             o.PostedAt = inPost.Time;
             o.IsFold = (byte?)inPost.IsFold.NullIfZero();
diff --git a/c#/crawler/src/Tieba/Crawl/Parser/ThreadParser.cs b/c#/crawler/src/Tieba/Crawl/Parser/ThreadParser.cs
@@ -23,15 +23,15 @@ protected override ThreadPost Convert(Thread inPost)
 #pragma warning restore S3358 // Ternary operators should not be nested
             o.IsGood = (byte?)inPost.IsGood.NullIfZero();
             o.TopicType = inPost.LivePostType.NullIfEmpty();
-            o.Title = inPost.Title; // might be write back by ReplyCrawlFacade.SaveParentThreadTitle()
+            o.Title = inPost.Title; // might be written back by ReplyCrawlFacade.SaveParentThreadTitle()
             o.AuthorUid = inPost.AuthorId;
             o.PostedAt = (uint)inPost.CreateTime;
             o.LatestReplyPostedAt = (uint)inPost.LastTimeInt;
             o.ReplyCount = inPost.ReplyNum < 0 ? 0 : (uint?)inPost.ReplyNum.NullIfZero(); // rarely respond with -1
             o.ViewCount = (uint?)inPost.ViewNum.NullIfZero();
             o.ShareCount = (uint?)inPost.ShareNum.NullIfZero();
 
-            // when the thread is livepost or Thread.AgreeNum == 0, the agree field will not exists
+            // when the thread is livepost or Thread.AgreeNum == 0, the agree field will not exist
             o.AgreeCount = (int?)inPost.Agree?.AgreeNum.NullIfZero() ?? inPost.AgreeNum.NullIfZero();
             o.DisagreeCount = (int?)inPost.Agree?.DisagreeNum.NullIfZero();
             o.Geolocation = Helper.SerializedProtoBufOrNullIfEmpty(inPost.Location);
diff --git a/c#/crawler/src/Tieba/Crawl/Saver/CommonInSavers.cs b/c#/crawler/src/Tieba/Crawl/Saver/CommonInSavers.cs
@@ -127,7 +127,7 @@ private static bool IsLatestReplierUser(string pName, PropertyEntry p, EntityEnt
         // create another user instance with only fields of latest replier filled
         var latestReplier = User.CreateLatestReplier(user.Uid, user.Name, user.DisplayName);
 
-        // if they are same by fields values, the original one is a latest replier
+        // if they are same by fields values, the original one is the latest replier
         // that previously generated by ParseLatestRepliers()
         return IsSameUser(user, latestReplier);
     }
diff --git a/c#/crawler/src/Tieba/Crawl/Saver/ReplySaver.cs b/c#/crawler/src/Tieba/Crawl/Saver/ReplySaver.cs
@@ -123,7 +123,7 @@ private Action SaveReplySignatures(CrawlerDbContext db, IEnumerable<ReplyPost> r
     {
         Helper.GetNowTimestamp(out var now);
         var signatures = replies
-            .Where(r => r.SignatureId != null && r.Signature != null)
+            .Where(r => r is {SignatureId: not null, Signature: not null})
             .DistinctBy(r => r.SignatureId)
             .Select(r => new ReplySignature
             {
diff --git a/c#/crawler/src/Tieba/Crawl/Saver/SaverChangeSet.cs b/c#/crawler/src/Tieba/Crawl/Saver/SaverChangeSet.cs
@@ -24,5 +24,7 @@ public SaverChangeSet(
 
     public ReadOnlyCollection<(TPost Before, TPost After)> Existing { get; }
     public ReadOnlyCollection<TPost> NewlyAdded { get; }
+
+    // ReSharper disable once CollectionNeverUpdated.Global
     public ReadOnlyCollection<TPost> AllAfter { get; }
 }
diff --git a/c#/crawler/src/Tieba/Crawl/Saver/StaticCommonInSavers.cs b/c#/crawler/src/Tieba/Crawl/Saver/StaticCommonInSavers.cs
@@ -5,7 +5,7 @@ public abstract class StaticCommonInSavers
     public delegate bool FieldChangeIgnoranceDelegate(
         Type whichPostType, string propName, object? oldValue, object? newValue);
 
-    // static field in this non generic class will be shared across all reified generic derived classes
+    // static field in this non-generic class will be shared across all reified generic derived classes
     protected static Dictionary<Type, Dictionary<string, PropertyInfo>> RevisionPropertiesCache { get; } = GetPropsKeyByType(
         [typeof(ThreadRevision), typeof(ReplyRevision), typeof(SubReplyRevision), typeof(UserRevision)]);
 
@@ -37,22 +37,22 @@ when Math.Abs((newValue as int? ?? 0) - (oldValue as int? ?? 0)) <= 10:
             if (whichPostType == typeof(ThreadPost))
             {
                 switch (propName)
-                { // will be update by ThreadLateCrawlerAndSaver
+                { // will be updated by ThreadLateCrawlerAndSaver
                     case nameof(ThreadPost.AuthorPhoneType):
                     // prevent overwrite existing value of field liker_id which is saved by legacy crawler
-                    // and Zan itself is deprecated by tieba so it shouldn't get updated
+                    // and Zan itself is deprecated by tieba, so it shouldn't get updated
                     case nameof(ThreadPost.Zan):
                     // possible randomly respond with null
                     case nameof(ThreadPost.Geolocation) when newValue is null:
-                    // empty string means the author had not write a title
+                    // empty string means the author had not written a title
                     // its value generated from the first reply within response of reply crawler
                     // will be later set by ReplyCrawlFacade.SaveParentThreadTitle()
                     case nameof(ThreadPost.Title)
                         when newValue is ""
 
                              // prevent repeatedly update with different title
                              // due to the thread is a multi forum topic thread
-                             // thus its title can be vary within the forum and within the thread
+                             // thus its title can be varied within the forum and within the thread
                              || (newValue is not "" && oldValue is not ""):
                     // possible randomly respond with 0.NullIfZero()
                     case nameof(ThreadPost.DisagreeCount) when newValue is null && oldValue is not null:
@@ -76,6 +76,8 @@ when newValue is ""
         { // ignore revision that figures update existing old users that don't have ip geolocation
             if (whichPostType == typeof(User)
                 && propName == nameof(User.IpGeolocation) && oldValue is null) return true;
+
+            // ReSharper disable once InvertIf
             if (whichPostType == typeof(ThreadPost))
             {
                 switch (propName)
@@ -89,7 +91,7 @@ when newValue is ""
             return false;
         });
 
-    private static Dictionary<Type, Dictionary<string, PropertyInfo>> GetPropsKeyByType(List<Type> types) =>
+    private static Dictionary<Type, Dictionary<string, PropertyInfo>> GetPropsKeyByType(IEnumerable<Type> types) =>
         types.ToDictionary(type => type, type => type.GetProperties().ToDictionary(prop => prop.Name));
 
     public record FieldChangeIgnoranceDelegates(
diff --git a/c#/crawler/src/Tieba/Crawl/Saver/SubReplySaver.cs b/c#/crawler/src/Tieba/Crawl/Saver/SubReplySaver.cs
@@ -20,7 +20,7 @@ public class SubReplySaver(
             // FansNickname in sub reply response will always be null
             nameof(User.FansNickname) when oldValue is not null && newValue is null => true,
 
-            // DisplayName in users embedded in sub replies from response will be the legacy nick name
+            // DisplayName in users embedded in sub replies from response will be the legacy nickname
             nameof(User.DisplayName) => true,
             _ => false
         }, (_, _, _, _) => false);
diff --git a/c#/crawler/src/Tieba/Crawl/ThreadLateCrawlerAndSaver.cs b/c#/crawler/src/Tieba/Crawl/ThreadLateCrawlerAndSaver.cs
@@ -92,7 +92,7 @@ private async Task<ThreadPost?> CrawlThread
                             "Field phone_type is missing in response json.thread.thread_info, it might be a historical thread.")
 
                     // silent fail without any retry since the field `json.thread.thread_info`
-                    // might not exists in current and upcoming responses
+                    // might not exist in current and upcoming responses
                     : null;
 #pragma warning restore S3358 // Ternary operators should not be nested
             }
@@ -119,6 +119,7 @@ private async Task<ThreadPost?> CrawlThread
                 logger.LogError(e, "Exception");
             }
 
+            // ReSharper disable once InvertIf
             if (e is not TiebaException {ShouldRetry: false})
             {
                 _locks.AcquireFailed(crawlerLockId, page: 1, failureCount);
diff --git a/c#/crawler/src/Tieba/Crawl/UserParserAndSaver.cs b/c#/crawler/src/Tieba/Crawl/UserParserAndSaver.cs
@@ -49,7 +49,7 @@ public void ParseUsers(IEnumerable<TbClient.User> users) =>
                     : (portrait, null);
 
             var uid = el.Uid;
-            if (uid == 0) return null; // in client version 12.x the last user in list will be a empty user with uid 0
+            if (uid == 0) return null; // in client version 12.x the last user in list will be an empty user with uid 0
             var (portrait, portraitUpdatedAt) = ExtractPortrait(el.Portrait);
             if (uid < 0) // historical anonymous user
             {
diff --git a/c#/crawler/src/Worker/ArchiveCrawlWorker.cs b/c#/crawler/src/Worker/ArchiveCrawlWorker.cs
@@ -15,10 +15,14 @@ public class ArchiveCrawlWorker(
     : ErrorableWorker(shouldExitOnException: true, shouldExitOnFinish: true)
 {
     // as of March 2019, tieba had restrict the max accepted value for page param of forum's threads api
-    // any request with page offset that larger than 10k threads will be respond with results from the first page
+    // any request with page offset that larger than 10k threads will be responded with results from the first page
     // in May 2023, they enlarged the limit to 100k threads: https://github.com/Starry-OvO/aiotieba/issues/124
     private const int MaxCrawlablePage = 3334; // 100k threads / 30 per request (from Rn param) = 3333.3...
+
+    // ReSharper disable once ConvertToConstant.Local
     private readonly string _forumName = "";
+
+    // ReSharper disable once ConvertToConstant.Local
     private readonly Fid _fid = 0;
 
     // https://en.wikipedia.org/wiki/Moving_average#Cumulative_average
diff --git a/c#/crawler/src/Worker/RetryCrawlWorker.cs b/c#/crawler/src/Worker/RetryCrawlWorker.cs
@@ -65,7 +65,7 @@ private async Task RetryThreadLate(
             var fid = tidGroupByFid.Key;
             FailureCount FailureCountSelector(Tid tid) =>
 
-                // it should always contains only one page which is 1
+                // it should always contain only one page which is 1
                 failureCountWithPagesKeyByLockId[new(fid, tid)].Single().Value;
             var failureCountsKeyByTid = tidGroupByFid
                 .Cast<Tid>().ToDictionary(tid => tid, FailureCountSelector);
diff --git a/c#/tbm.sln.DotSettings b/c#/tbm.sln.DotSettings
@@ -1,8 +1,10 @@
-﻿<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:Boolean x:Key="/Default/CodeStyle/Naming/CSharpNaming/ApplyAutoDetectedRules/@EntryValue">False</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Roslynator/@EntryIndexedValue">True</s:Boolean>
     <s:Boolean x:Key="/Default/UserDictionary/Words/=Tieba/@EntryIndexedValue">True</s:Boolean>
     <s:Boolean x:Key="/Default/UserDictionary/Words/=tesseract/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=Spid/@EntryIndexedValue">True</s:Boolean>
+    <s:Boolean x:Key="/Default/UserDictionary/Words/=Eithers/@EntryIndexedValue">True</s:Boolean>
     <!-- table name prefixes -->
     <s:Boolean x:Key="/Default/UserDictionary/Words/=tbm_/@EntryIndexedValue">True</s:Boolean>
     <s:Boolean x:Key="/Default/UserDictionary/Words/=tbmi_/@EntryIndexedValue">True</s:Boolean>

Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,8 @@ await Task.WhenAll(shouldCrawlParentPosts.Select(async t =>`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`private Action<Exception> SaveThreadMissingFirstReply`
	`131`	`+`
	`132`	`+ // ReSharper disable once SuggestBaseTypeForParameter`
`131`	`133`	`(Fid fid, Tid tid, SavedThreadsList savedThreads) => ex =>`
`132`	`134`	`{`
`133`	`135`	`if (ex is not EmptyPostListException) return;`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,7 @@ public async Task<BaseCrawlFacade<TPost, TBaseRevision, TResponse, TPostProtoBuf`
`81`	`81`	`endPage = Math.Min(endPage, maxPage ?? Page.MaxValue);`
`82`	`82`	`}, startPage, previousFailureCount: 0, stoppingToken);`
`83`	`83`
	`84`	`+ // ReSharper disable once InvertIf`
`84`	`85`	`if (!isStartPageCrawlFailed)`
`85`	`86`	`{`
`86`	`87`	`var pagesAfterStart = Enumerable.Range(`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,9 @@ public void ParsePosts(`
`23`	`23`	`.Where(u => u.CalculateSize() != 0)); // remove empty users`
`24`	`24`	`}`
`25`	`25`
`26`		`- protected abstract PostId PostIdSelector(TPost post);`
	`26`	`+ // ReSharper disable once UnusedMemberInSuper.Global`
`27`	`27`	`protected abstract TPost Convert(TPostProtoBuf inPost);`
`28`	`28`	`protected abstract IEnumerable<TPost> ParsePostsInternal(IList<TPostProtoBuf> inPosts, List<TbClient.User?> outUsers);`
`29`	`29`	`protected virtual bool ShouldSkipParse(CrawlRequestFlag requestFlag) => false;`
	`30`	`+ protected abstract PostId PostIdSelector(TPost post);`
`30`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -127,7 +127,7 @@ private static bool IsLatestReplierUser(string pName, PropertyEntry p, EntityEnt`
`127`	`127`	`// create another user instance with only fields of latest replier filled`
`128`	`128`	`var latestReplier = User.CreateLatestReplier(user.Uid, user.Name, user.DisplayName);`
`129`	`129`
`130`		`- // if they are same by fields values, the original one is a latest replier`
	`130`	`+ // if they are same by fields values, the original one is the latest replier`
`131`	`131`	`// that previously generated by ParseLatestRepliers()`
`132`	`132`	`return IsSameUser(user, latestReplier);`
`133`	`133`	`}`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ private Action SaveReplySignatures(CrawlerDbContext db, IEnumerable<ReplyPost> r`
`123`	`123`	`{`
`124`	`124`	`Helper.GetNowTimestamp(out var now);`
`125`	`125`	`var signatures = replies`
`126`		`- .Where(r => r.SignatureId != null && r.Signature != null)`
	`126`	`+ .Where(r => r is {SignatureId: not null, Signature: not null})`
`127`	`127`	`.DistinctBy(r => r.SignatureId)`
`128`	`128`	`.Select(r => new ReplySignature`
`129`	`129`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,7 @@ public SaverChangeSet(`
`24`	`24`
`25`	`25`	`public ReadOnlyCollection<(TPost Before, TPost After)> Existing { get; }`
`26`	`26`	`public ReadOnlyCollection<TPost> NewlyAdded { get; }`
	`27`	`+`
	`28`	`+ // ReSharper disable once CollectionNeverUpdated.Global`
`27`	`29`	`public ReadOnlyCollection<TPost> AllAfter { get; }`
`28`	`30`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ private async Task<ThreadPost?> CrawlThread`
`92`	`92`	`"Field phone_type is missing in response json.thread.thread_info, it might be a historical thread.")`
`93`	`93`
`94`	`94`	// silent fail without any retry since the field `json.thread.thread_info`
`95`		`- // might not exists in current and upcoming responses`
	`95`	`+ // might not exist in current and upcoming responses`
`96`	`96`	`: null;`
`97`	`97`	`#pragma warning restore S3358 // Ternary operators should not be nested`
`98`	`98`	`}`
`@@ -119,6 +119,7 @@ private async Task<ThreadPost?> CrawlThread`
`119`	`119`	`logger.LogError(e, "Exception");`
`120`	`120`	`}`
`121`	`121`
	`122`	`+ // ReSharper disable once InvertIf`
`122`	`123`	`if (e is not TiebaException {ShouldRetry: false})`
`123`	`124`	`{`
`124`	`125`	`_locks.AcquireFailed(crawlerLockId, page: 1, failureCount);`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ public void ParseUsers(IEnumerable<TbClient.User> users) =>`
`49`	`49`	`: (portrait, null);`
`50`	`50`
`51`	`51`	`var uid = el.Uid;`
`52`		`- if (uid == 0) return null; // in client version 12.x the last user in list will be a empty user with uid 0`
	`52`	`+ if (uid == 0) return null; // in client version 12.x the last user in list will be an empty user with uid 0`
`53`	`53`	`var (portrait, portraitUpdatedAt) = ExtractPortrait(el.Portrait);`
`54`	`54`	`if (uid < 0) // historical anonymous user`
`55`	`55`	`{`