[Enhancement] Rename CSharpCodeRunnerController to a language-agnostic name #285
Assignees
spikerj (Joseph Spiker)
Clear assignees
spikerj (Joseph Spiker)
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: spikerj/spikersoft-issues#285
Reference in New Issue
Block a user
Summary
CSharpCodeRunnerController(routeapi/CSharpCodeRunner) is no longer C#-specific. It is the shared code-execution endpoint for the C#, Python, and JavaScript playgrounds — all three frontends POST to/api/CSharpCodeRunner/runand/api/CSharpCodeRunner/lessonand signal their language viametadata.language. The C#-centric name is misleading and was the proximate cause of the recent #280 regression (a dev hardcodedmetadata.language = "csharp"in the controller, assuming it only served C#, which broke JS/Python lesson submissions).Rename the controller, its route, and the related types to a language-agnostic name (suggestion:
CodeRunnerController/api/CodeRunner, orCodeExecutionController/api/CodeExecution) so the shared nature is obvious and future contributors don't reintroduce language-specific assumptions.Scope
Backend (
spikersoft-backend)SpikerSoft.Api/Domain/CodeExecution/CSharpCodeRunnerController.cs→ language-agnostic controller + class name.[Route("api/[controller]")]so the public path changes (or keep a back-compat route — see Compatibility below).SpikerSoft.Tests.Unit/Controllers/CSharpCodeRunnerControllerTests.csand update references.CSharpCodeRunnerControllerTests,README.md, and any other backend mentions ofCSharpCodeRunner.CCodeRunnerController(api/CCodeRunner, C/C++) andSqlCodeRunnerController(api/SqlCodeRunner). Consider whetherCCodeRunnershould also be generalized since it serves both C and C++ — optional, lower priority.Frontend (
spikersoft-angular) — all consumers of/CSharpCodeRunnerThese three runner services hardcode the controller segment and must be updated to the new path:
libraries/features/dev-tools-csharp-runner/src/lib/csharp-runner.service.ts(line ~66:apiUrl = \${environment.apiUrl}/CSharpCodeRunner``)libraries/features/dev-tools-javascript-runner/src/lib/javascript-runner.service.ts(line ~33)libraries/features/dev-tools-python-runner/src/lib/python-runner.service.ts(line ~41)Each uses
${apiUrl}/runand${apiUrl}/lesson.For reference (NOT affected — they use their own controllers, listed so the rename isn't accidentally over-applied):
ClangRunnerServicewithapiController: "CCodeRunner"(dev-tools-c-runner,dev-tools-cpp-runner)./SqlCodeRunner(dev-tools-sql-runner)./Lessons(no code-runner controller).Compatibility / rollout
The controller route is a public API surface consumed by the deployed SPA. To avoid a hard breakage during deploy skew:
api/CSharpCodeRunneras a deprecated alias for one release, ship the frontend pointed at the new route, then remove the alias in a follow-up.Pick one and note it on the PR.
Acceptance criteria
CSharpCodeRunnerexcept an intentional back-compat alias (if Option A).runandlessonsubmit after the change.CCodeRunner/SqlCodeRunnercontrollers untouched (or generalization tracked separately).Severity
Low (tech debt / maintainability) — but directly prevents a class of regressions like #280.
Resolved — both halves merged to
master:CSharpCodeRunnerController→CodeRunnerController, canonical routeapi/CodeRunnerwithapi/CSharpCodeRunnerretained as a deprecated alias (Option A). Updated all backend references + docs.api/CodeRunner.Sibling
CCodeRunner/SqlCodeRunnercontrollers left untouched as intended. Follow-up #286 tracks removing the deprecatedapi/CSharpCodeRunneralias once the deprecation window passes. Closing.