Merge pull request #73 from rubberduck-vba/webhook

Add ClearCache authenticated endpoint

Author: retailcoder

rubberduckvba.Server/Api/Admin/AdminController.cs

@@ -2,12 +2,13 @@
 using Microsoft.AspNetCore.Cors;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Options;
+using rubberduckvba.Server.Services;
 
 namespace rubberduckvba.Server.Api.Admin;
 
 
 [ApiController]
-public class AdminController(ConfigurationOptions options, HangfireLauncherService hangfire) : ControllerBase
+public class AdminController(ConfigurationOptions options, HangfireLauncherService hangfire, CacheService cache) : ControllerBase
 {
     /// <summary>
     /// Enqueues a job that updates xmldoc content from the latest release/pre-release tags.
@@ -35,6 +36,15 @@ public IActionResult UpdateTagMetadata()
         return Ok(jobId);
     }
 
+    [Authorize("github")]
+    [EnableCors("CorsPolicy")]
+    [HttpPost("admin/cache/clear")]
+    public IActionResult ClearCache()
+    {
+        cache.Clear();
+        return Ok();
+    }
+
 #if DEBUG
     [HttpGet("admin/config/current")]
     public IActionResult Config()

rubberduckvba.Server/Services/CacheService.cs

@@ -150,6 +150,12 @@ public void Invalidate(AnnotationsFeatureViewModel newContent)
         }
     }
 
+    public void Clear()
+    {
+        _cache.Clear();
+        _logger.LogInformation("Cache was cleared.");
+    }
+
     private bool IsTagsCacheValid() => IsCacheValid(TagsJobState, () => TagsJobState);
 
     private bool IsXmldocCacheValid() => IsCacheValid(XmldocJobState, () => XmldocJobState);

rubberduckvba.client/src/app/components/auth-menu/auth-menu.component.html

@@ -26,6 +26,12 @@
                         Update xmldoc metadata
                     </button>
                 </div>
+                <hr />
+                <div ngbDropdownItem>
+                    <button type="button" role="button" class="nav-link text-dark btn-link" title="" (click)="confirmClearCache()">
+                        Clear cache
+                    </button>
+                </div>
             </div>
         </div>
     </div>
@@ -100,3 +106,26 @@ <h6><fa-icon class="mx-1" [icon]="['fas', 'info-circle']"></fa-icon>Confirm</h6>
         </div>
     </div>
 </ng-template>
+
+<ng-template #confirmclearcachebox let-modal>
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h5>Clear Cache</h5>
+            </div>
+            <div class="modal-body">
+                <div class="border-primary border-bottom border-top bg-light text-primary p-2 my-1">
+                    <h6><fa-icon class="mx-1" [icon]="['fas', 'info-circle']"></fa-icon>Confirm</h6>
+                    <p>This will clear the memory cache, forcing the next request to fetch from the backend database.</p>
+                </div>
+                <p class="mt-4">
+                    Proceed?
+                </p>
+            </div>
+            <div class="modal-footer">
+                <button id="cancel-xmldoc" type="button" class="btn btn-secondary" data-dismiss="modal" aria-label="Close" (click)="modal.dismiss('cancel')">Close</button>
+                <button id="accept-xmldoc" type="button" class="btn btn-primary" (click)="clearCache()">Proceed</button>
+            </div>
+        </div>
+    </div>
+</ng-template>

rubberduckvba.client/src/app/components/auth-menu/auth-menu.component.ts

@@ -26,6 +26,7 @@ export class AuthMenuComponent implements OnInit {
   @ViewChild('confirmbox', { read: TemplateRef }) confirmbox: TemplateRef<any> | undefined;
   @ViewChild('confirmtagsbox', { read: TemplateRef }) confirmtagsbox: TemplateRef<any> | undefined;
   @ViewChild('confirmxmldocsbox', { read: TemplateRef }) confirmxmldocsbox: TemplateRef<any> | undefined;
+  @ViewChild('confirmclearcachebox', { read: TemplateRef }) confirmclearcachebox: TemplateRef<any> | undefined;
   public modal = inject(NgbModal);
 
   constructor(private auth: AuthService, private api: ApiClientService, private fa: FaIconLibrary) {
@@ -57,6 +58,10 @@ export class AuthMenuComponent implements OnInit {
     this.modal.open(this.confirmxmldocsbox);
   }
 
+  public confirmClearCache(): void {
+    this.modal.open(this.confirmclearcachebox);
+  }
+
   public signin(): void {
     this.auth.signin();
     this.getUserInfo();
@@ -76,4 +81,9 @@ export class AuthMenuComponent implements OnInit {
     this.modal.dismissAll();
     this.api.updateXmldocMetadata().subscribe(jobId => console.log(`UpdateXmldocMetadata has scheduled job id ${jobId}`));
   }
+
+  public clearCache(): void {
+    this.modal.dismissAll();
+    this.api.clearCache().subscribe(() => console.log(`Cache has been cleared`));
+  }
 }

rubberduckvba.client/src/app/services/api-client.service.ts

@@ -65,6 +65,11 @@ export class ApiClientService {
     return this.data.postAsync(url);
   }
 
+  public clearCache(): Observable<any> {
+    const url = `${environment.apiBaseUrl}admin/cache/clear`;
+    return this.data.postAsync(url);
+  }
+
   public getIndenterDefaults(): Observable<IndenterViewModel> {
     const url = `${environment.apiBaseUrl}indenter/defaults`;
     return this.data.getAsync<IndenterViewModel>(url).pipe(map(model => new IndenterViewModelClass(model)));