Revert out-of-scope controller/frontend API change

Author: imnasnainaec

Backend.Tests/Controllers/WordControllerTests.cs

@@ -385,9 +385,26 @@ public async Task TestRestoreWord()
 
             var result = await _wordController.RestoreWord(ProjId, word.Id);
 
-            Assert.That(result, Is.InstanceOf<OkResult>());
+            Assert.That(result, Is.InstanceOf<OkObjectResult>());
+            Assert.That(((OkObjectResult)result).Value, Is.True);
+            Assert.That(await _wordRepo.GetAllWords(ProjId), Does.Contain(word).UsingPropertiesComparer());
+            Assert.That(await _wordRepo.GetAllFrontier(ProjId), Does.Contain(word).UsingPropertiesComparer());
+        }
+
+        [Test]
+        public async Task TestRestoreWordAlreadyInFrontier()
+        {
+            var word = await _wordRepo.Create(Util.RandomWord(ProjId));
+
             Assert.That(await _wordRepo.GetAllWords(ProjId), Does.Contain(word).UsingPropertiesComparer());
             Assert.That(await _wordRepo.GetAllFrontier(ProjId), Does.Contain(word).UsingPropertiesComparer());
+            var frontierCount = await _wordRepo.GetFrontierCount(ProjId);
+
+            var result = await _wordController.RestoreWord(ProjId, word.Id);
+
+            Assert.That(result, Is.InstanceOf<OkObjectResult>());
+            Assert.That(((OkObjectResult)result).Value, Is.False);
+            Assert.That(await _wordRepo.GetFrontierCount(ProjId), Is.EqualTo(frontierCount));
         }
 
         [Test]
@@ -404,20 +421,7 @@ public async Task TestRestoreWordNoPermission()
         public async Task TestRestoreWordMissingWord()
         {
             var wordResult = await _wordController.RestoreWord(ProjId, MissingId);
-            Assert.That(wordResult, Is.InstanceOf<BadRequestResult>());
-        }
-
-        [Test]
-        public async Task TestRestoreWordAlreadyInFrontier()
-        {
-            var word = await _wordRepo.Create(Util.RandomWord(ProjId));
-
-            Assert.That(await _wordRepo.GetAllWords(ProjId), Does.Contain(word).UsingPropertiesComparer());
-            Assert.That(await _wordRepo.GetAllFrontier(ProjId), Does.Contain(word).UsingPropertiesComparer());
-
-            var result = await _wordController.RestoreWord(ProjId, word.Id);
-
-            Assert.That(result, Is.InstanceOf<BadRequestResult>());
+            Assert.That(wordResult, Is.InstanceOf<NotFoundResult>());
         }
 
         [Test]

Backend/Controllers/WordController.cs

@@ -248,10 +248,12 @@ public async Task<IActionResult> UpdateWord(
         }
 
         /// <summary> Restore a deleted <see cref="Word"/>. </summary>
+        /// <returns> bool: true if restored; false if already in frontier. </returns>
         [HttpGet("restore/{wordId}", Name = "RestoreWord")]
-        [ProducesResponseType(StatusCodes.Status200OK)]
-        [ProducesResponseType(StatusCodes.Status400BadRequest)]
+        [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(bool))]
         [ProducesResponseType(StatusCodes.Status403Forbidden)]
+        [ProducesResponseType(StatusCodes.Status404NotFound)]
+
         public async Task<IActionResult> RestoreWord(string projectId, string wordId)
         {
             using var activity = OtelService.StartActivityWithTag(otelTagName, "restoring a word");
@@ -260,8 +262,12 @@ public async Task<IActionResult> RestoreWord(string projectId, string wordId)
             {
                 return Forbid();
             }
+            if (await _wordRepo.GetWord(projectId, wordId) is null)
+            {
+                return NotFound();
+            }
 
-            return await _wordService.RestoreFrontierWords(projectId, [wordId]) ? Ok() : BadRequest();
+            return Ok(await _wordService.RestoreFrontierWords(projectId, [wordId]));
         }
 
         /// <summary> Revert words from a dictionary of word ids (key: to revert to; value: from frontier). </summary>

Backend/Models/Sense.cs

@@ -243,6 +243,6 @@ public enum Status
         Active,
         Deleted,
         Duplicate,
-        Protected,
+        Protected
     }
 }

src/api/api/word-api.ts

@@ -1041,7 +1041,7 @@ export const WordApiFp = function (configuration?: Configuration) {
       wordId: string,
       options?: any
     ): Promise<
-      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>
+      (axios?: AxiosInstance, basePath?: string) => AxiosPromise<boolean>
     > {
       const localVarAxiosArgs = await localVarAxiosParamCreator.restoreWord(
         projectId,
@@ -1315,7 +1315,7 @@ export const WordApiFactory = function (
       projectId: string,
       wordId: string,
       options?: any
-    ): AxiosPromise<void> {
+    ): AxiosPromise<boolean> {
       return localVarFp
         .restoreWord(projectId, wordId, options)
         .then((request) => request(axios, basePath));

src/backend/index.ts

@@ -959,9 +959,10 @@ export async function isInFrontier(
 export async function restoreWord(
   wordId: string,
   projectId?: string
-): Promise<void> {
+): Promise<boolean> {
   projectId ||= LocalStorage.getProjectId();
-  await wordApi.restoreWord({ projectId, wordId }, defaultOptions());
+  const params = { projectId, wordId };
+  return (await wordApi.restoreWord(params, defaultOptions())).data;
 }
 
 /** Revert word updates given in dictionary of word ids: