Cross-Service Token Ledger System

[JaimeStill]

Before a staffing package can be submitted, the origin service will have to register with the Staffing service, which will issue a Registration token:

public class Registration
{
    public Guid Id { get; set; }
    public string Name { get; set; }
}

public class RegistrationService
{
        readonly AppDbContext db;

        public RegistrationService(AppDbContext db)
        {
            this.db = db;
        }

        public async Task<StaffingRegistration> RegisterService(string service)
        {
            Registration registration = new()
            {
                Id = GenerateGuid(),
                Name = service
            };

            await db.Registrations.AddAsync(registration);
            await db.SaveChangesAsync();
        }

        async Task<Guid> GenerateGuid()
        {
            Guid guid = Guid.NewGuid();

            while(await GuidExists(guid))
                guid = Guid.NewGuid();

            return guid;
        }

        async Task<bool> GuidExists(Guid guid) =>
            await db.Registrations.AnyAsync(x => x.Id == guid);
}

[Route("api/[controller]")]
public class RegistrationController : Controller
{
    [HttpPost("[action]/{service}")]
    public async Task<IActionResult> RegisterService([FromRoute]string service) =>
        Ok(await registrationSvc.RegisterService(service));
}

Once registered, all cross-service API endpoints will require the registration ID to be provided in the endpoint route. This will allow the staffing service to track issued tokens across services by associating them with a registration ID.

Tokens that can be issued by the staffing service:

• Tracking - Issued when a Package is submitted. Provides URLs to API endpoints that provide the following information:
  • The status of the staffing package (Created, Pending, Returned, or Rejected).
  • The Workflow the package has been assigned, along with a link to the workflow instance.
  • The Process the Workflow is sitting at.
  • The collection of Resource objects that correspond to items in the origin service that are being staffed.
    • This is how items in the origin service can track their progress when submitted for a staffing action.
• Return - Issued when a Package has been returned by a Process. A Return will consist of one or more Remedy items. A Remedy will be a standardized action that must be resolved before the Process can move forward. Remedy items will indicate the following actions by the origin service authority:
  • An Administrative remedy requires an action be taken that does not involve a specific Resource submitted with the Package.
  • An Adjustment remedy indicates that a corrective action must be made against a Resource.
  • A Reroute remedy indicates that a Resource has been removed from the Package and the corresponding item should be submitted as part of a separate Package.
  • A Rejected remedy indicates that a Resource is not approved, rejected, or otherwise invalid and should be deleted. This does not indicate that the Package itself is rejected, just the Resource that received the Rejected remedy.
• Approved - Issued when a Workflow has been completed and approved. Includes a digital signature from the approval authority, as well as links to any finalized documents that were part of the workflow process.
• Rejected - Issued when a Workflow has been rejected. Includes a digital signature from the authority, along with a summary of the rejection.