add admin endpoints, edit summary/description

Author: retailcoder

rubberduckvba.Server/Api/Admin/AdminController.cs

@@ -7,14 +7,14 @@
 namespace rubberduckvba.Server.Api.Admin;
 
 [ApiController]
+[EnableCors(CorsPolicies.AllowAll)]
 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.
     /// </summary>
     /// <returns>The unique identifier of the enqueued job.</returns>
     [Authorize("github")]
-    [EnableCors(CorsPolicies.AllowAuthenticated)]
     [HttpPost("admin/update/xmldoc")]
     public IActionResult UpdateXmldocContent()
     {
@@ -27,7 +27,6 @@ public IActionResult UpdateXmldocContent()
     /// </summary>
     /// <returns>The unique identifier of the enqueued job.</returns>
     [Authorize("github")]
-    [EnableCors(CorsPolicies.AllowAuthenticated)]
     [HttpPost("admin/update/tags")]
     public IActionResult UpdateTagMetadata()
     {
@@ -36,7 +35,6 @@ public IActionResult UpdateTagMetadata()
     }
 
     [Authorize("github")]
-    [EnableCors(CorsPolicies.AllowAuthenticated)]
     [HttpPost("admin/cache/clear")]
     public IActionResult ClearCache()
     {
@@ -46,7 +44,6 @@ public IActionResult ClearCache()
 
 #if DEBUG
     [AllowAnonymous]
-    [EnableCors(CorsPolicies.AllowAll)]
     [HttpGet("admin/config/current")]
     public IActionResult Config()
     {

rubberduckvba.Server/Api/Features/FeatureEditViewModel.cs

@@ -17,7 +17,7 @@ public static FeatureEditViewModel Default(RepositoryId repository, FeatureOptio
             Repositories = repositories,
 
             RepositoryId = repository,
-            ParentId = parent?.Id,
+            FeatureId = parent?.Id,
             Name = parent is null ? "NewFeature" : $"New{parent.Name}Feature",
             Title = "Feature Title",
             ShortDescription = "A short description; markdown is supported.",
@@ -29,7 +29,7 @@ public Feature ToFeature()
         return new Feature
         {
             Id = Id ?? default,
-            FeatureId = ParentId,
+            ParentId = FeatureId,
             RepositoryId = RepositoryId,
             Name = Name,
             Title = Title,
@@ -43,7 +43,7 @@ public Feature ToFeature()
     public FeatureEditViewModel(Feature model, FeatureOptionViewModel[] features, RepositoryOptionViewModel[] repositories)
     {
         Id = model.Id;
-        ParentId = model.FeatureId;
+        FeatureId = model.ParentId;
         RepositoryId = model.RepositoryId;
 
         Name = model.Name;
@@ -59,7 +59,7 @@ public FeatureEditViewModel(Feature model, FeatureOptionViewModel[] features, Re
     }
 
     public int? Id { get; init; }
-    public int? ParentId { get; init; }
+    public int? FeatureId { get; init; }
     public RepositoryId RepositoryId { get; init; }
 
     public string Name { get; init; }

rubberduckvba.Server/Api/Features/FeatureViewModel.cs

@@ -11,7 +11,7 @@ public FeatureViewModel(Feature model, bool summaryOnly = false)
         DateInserted = model.DateTimeInserted;
         DateUpdated = model.DateTimeUpdated;
 
-        FeatureId = model.FeatureId;
+        FeatureId = model.ParentId;
         FeatureName = model.FeatureName;
 
         Name = model.Name;

rubberduckvba.Server/Api/Features/FeaturesController.cs

@@ -9,17 +9,24 @@
 
 namespace rubberduckvba.Server.Api.Features;
 
+public class MarkdownContentViewModel
+{
+    public string Content { get; init; } = string.Empty;
+}
+
 
 [AllowAnonymous]
+[EnableCors(CorsPolicies.AllowAll)]
 public class FeaturesController : RubberduckApiController
 {
     private readonly CacheService cache;
     private readonly IRubberduckDbService db;
     private readonly FeatureServices features;
     private readonly IRepository<TagAssetEntity> assetsRepository;
     private readonly IRepository<TagEntity> tagsRepository;
+    private readonly IMarkdownFormattingService markdownService;
 
-    public FeaturesController(CacheService cache, IRubberduckDbService db, FeatureServices features,
+    public FeaturesController(CacheService cache, IRubberduckDbService db, FeatureServices features, IMarkdownFormattingService markdownService,
         IRepository<TagAssetEntity> assetsRepository, IRepository<TagEntity> tagsRepository, ILogger<FeaturesController> logger)
         : base(logger)
     {
@@ -28,6 +35,7 @@ public FeaturesController(CacheService cache, IRubberduckDbService db, FeatureSe
         this.features = features;
         this.assetsRepository = assetsRepository;
         this.tagsRepository = tagsRepository;
+        this.markdownService = markdownService;
     }
 
     private static RepositoryOptionViewModel[] RepositoryOptions { get; } =
@@ -38,8 +46,6 @@ await db.GetTopLevelFeatures(repositoryId)
             .ContinueWith(t => t.Result.Select(e => new FeatureOptionViewModel { Id = e.Id, Name = e.Name, Title = e.Title }).ToArray());
 
     [HttpGet("features")]
-    [EnableCors(CorsPolicies.AllowAll)]
-    [AllowAnonymous]
     public IActionResult Index()
     {
         return GuardInternalAction(() =>
@@ -68,8 +74,6 @@ public IActionResult Index()
     }
 
     [HttpGet("features/{name}")]
-    [EnableCors(CorsPolicies.AllowAll)]
-    [AllowAnonymous]
     public IActionResult Info([FromRoute] string name)
     {
         return GuardInternalAction(() =>
@@ -85,8 +89,6 @@ public IActionResult Info([FromRoute] string name)
     }
 
     [HttpGet("inspections/{name}")]
-    [EnableCors(CorsPolicies.AllowAll)]
-    [AllowAnonymous]
     public IActionResult Inspection([FromRoute] string name)
     {
         return GuardInternalAction(() =>
@@ -107,8 +109,6 @@ public IActionResult Inspection([FromRoute] string name)
     }
 
     [HttpGet("annotations/{name}")]
-    [EnableCors(CorsPolicies.AllowAll)]
-    [AllowAnonymous]
     public IActionResult Annotation([FromRoute] string name)
     {
         return GuardInternalAction(() =>
@@ -129,8 +129,6 @@ public IActionResult Annotation([FromRoute] string name)
     }
 
     [HttpGet("quickfixes/{name}")]
-    [EnableCors(CorsPolicies.AllowAll)]
-    [AllowAnonymous]
     public IActionResult QuickFix([FromRoute] string name)
     {
         return GuardInternalAction(() =>
@@ -151,7 +149,6 @@ public IActionResult QuickFix([FromRoute] string name)
     }
 
     [HttpGet("features/create")]
-    [EnableCors(CorsPolicies.AllowAuthenticated)]
     [Authorize("github")]
     public async Task<ActionResult<FeatureEditViewModel>> Create([FromQuery] RepositoryId repository = RepositoryId.Rubberduck, [FromQuery] int? parentId = default)
     {
@@ -163,7 +160,6 @@ public async Task<ActionResult<FeatureEditViewModel>> Create([FromQuery] Reposit
     }
 
     [HttpPost("create")]
-    [EnableCors(CorsPolicies.AllowAuthenticated)]
     [Authorize("github")]
     public async Task<ActionResult<FeatureEditViewModel>> Create([FromBody] FeatureEditViewModel model)
     {
@@ -179,14 +175,14 @@ public async Task<ActionResult<FeatureEditViewModel>> Create([FromBody] FeatureE
         }
 
         var feature = model.ToFeature();
-        var result = await db.SaveFeature(feature);
 
+        var result = await db.SaveFeature(feature);
         var features = await GetFeatureOptions(model.RepositoryId);
+
         return Ok(new FeatureEditViewModel(result, features, RepositoryOptions));
     }
 
     [HttpPost("features/update")]
-    [EnableCors(CorsPolicies.AllowAuthenticated)]
     [Authorize("github")]
     public async Task<ActionResult<FeatureEditViewModel>> Update([FromBody] FeatureEditViewModel model)
     {
@@ -201,12 +197,25 @@ public async Task<ActionResult<FeatureEditViewModel>> Update([FromBody] FeatureE
             return BadRequest("Model is invalid for this endpoint.");
         }
 
-        var result = await db.SaveFeature(model.ToFeature());
+        var feature = model.ToFeature();
+
+        var result = await db.SaveFeature(feature);
         var features = await GetFeatureOptions(model.RepositoryId);
 
         return new FeatureEditViewModel(result, features, RepositoryOptions);
     }
 
+    [HttpPost("markdown/format")]
+    public MarkdownContentViewModel FormatMarkdown([FromBody] MarkdownContentViewModel model)
+    {
+        var markdown = model.Content;
+        var formatted = markdownService.FormatMarkdownDocument(markdown, withSyntaxHighlighting: true);
+        return new MarkdownContentViewModel
+        {
+            Content = formatted
+        };
+    }
+
     private InspectionsFeatureViewModel GetInspections()
     {
         InspectionsFeatureViewModel result;
@@ -274,5 +283,4 @@ private FeatureViewModel GetFeature(string name)
 
         return result;
     }
-
-}
+}

rubberduckvba.Server/Model/Entity/FeatureEntity.cs

@@ -4,7 +4,7 @@ namespace rubberduckvba.Server.Model.Entity;
 
 public record class FeatureEntity : Entity
 {
-    public int? FeatureId { get; init; }
+    public int? ParentId { get; init; }
     public string FeatureName { get; init; } = default!;
     public int RepositoryId { get; init; }
     public string Title { get; init; } = default!;

rubberduckvba.Server/Model/Feature.cs

@@ -27,7 +27,7 @@ public Feature(FeatureEntity entity) : this()
         DateTimeInserted = entity.DateTimeInserted;
         DateTimeUpdated = entity.DateTimeUpdated;
         Name = entity.Name;
-        FeatureId = entity.FeatureId;
+        ParentId = entity.ParentId;
         FeatureName = entity.FeatureName;
         RepositoryId = (Services.RepositoryId)entity.RepositoryId;
         Title = entity.Title;
@@ -45,7 +45,7 @@ public Feature(FeatureEntity entity) : this()
     public DateTime? DateTimeUpdated { get; init; }
     public string Name { get; init; } = string.Empty;
 
-    public int? FeatureId { get; init; }
+    public int? ParentId { get; init; }
     public string FeatureName { get; init; } = string.Empty;
     public Services.RepositoryId RepositoryId { get; init; } = Services.RepositoryId.Rubberduck;
     public string Title { get; init; } = string.Empty;
@@ -69,7 +69,7 @@ public Feature(FeatureEntity entity) : this()
         IsNew = IsNew,
         Name = Name,
         ShortDescription = ShortDescription,
-        FeatureId = FeatureId,
+        ParentId = ParentId,
         FeatureName = FeatureName,
         RepositoryId = (int)Services.RepositoryId.Rubberduck,
         Title = Title,

rubberduckvba.Server/Program.cs

@@ -35,7 +35,6 @@ public class HangfireAuthenticationFilter : IDashboardAuthorizationFilter
 public static class CorsPolicies
 {
     public const string AllowAll = "AllowAll";
-    public const string AllowAuthenticated = "AllowAuthenticated";
 }
 
 public class Program
@@ -57,17 +56,9 @@ public static void Main(string[] args)
             {
                 policy
                     .SetIsOriginAllowed(origin => true)
-                    .AllowAnyHeader()
-                    .WithMethods("OPTIONS", "GET", "POST")
-                    .Build();
-            });
-            builder.AddPolicy(CorsPolicies.AllowAuthenticated, policy =>
-            {
-                policy
-                    .SetIsOriginAllowed(origin => true)
-                    .WithHeaders("X-ACCESS-TOKEN")
                     .WithMethods("OPTIONS", "GET", "POST")
-                    .AllowCredentials()
+                    .AllowAnyHeader()
+                    .AllowAnyOrigin()
                     .Build();
             });
         });

rubberduckvba.Server/Services/RubberduckDbService.cs

@@ -160,7 +160,7 @@ public async Task<FeatureGraph> ResolveFeature(RepositoryId repositoryId, string
     {
         var features = _featureServices.Get(topLevelOnly: false).ToList();
         var feature = features.Single(e => string.Equals(e.Name, name, StringComparison.OrdinalIgnoreCase));
-        var children = features.Where(e => e.FeatureId == feature.Id);
+        var children = features.Where(e => e.ParentId == feature.Id);
         return new FeatureGraph(feature.ToEntity())
         {
             Features = children.ToArray()

rubberduckvba.Server/Services/rubberduckdb/FeatureServices.cs

@@ -15,7 +15,7 @@ public class FeatureServices(
     public IEnumerable<Feature> Get(bool topLevelOnly = true)
     {
         return featureRepository.GetAll()
-            .Where(e => !topLevelOnly || e.FeatureId is null)
+            .Where(e => !topLevelOnly || e.ParentId is null)
             .Select(e => new Feature(e));
     }
 

rubberduckvba.client/src/app/app.module.ts

@@ -26,6 +26,8 @@ import { AnnotationItemBoxComponent } from './components/feature-item-box/annota
 import { BlogLinkBoxComponent } from './components/blog-link-box/blog-link-box.component';
 import { QuickFixItemBoxComponent } from './components/feature-item-box/quickfix-item-box/quickfix-item-box.component';
 
+import { EditFeatureComponent } from './components/edit-feature/edit-feature.component';
+
 import { HomeComponent } from './routes/home/home.component';
 import { AboutComponent } from './routes/about/about.component';
 import { FeaturesComponent } from './routes/features/features.component';
@@ -78,7 +80,8 @@ export class LowerCaseUrlSerializer extends DefaultUrlSerializer {
     InspectionComponent,
     AnnotationComponent,
     QuickFixComponent,
-    AboutComponent
+    AboutComponent,
+    EditFeatureComponent
   ],
   bootstrap: [AppComponent],
   imports: [