update notes

Author: maxdml

dbos/admin_server.go

@@ -120,7 +120,7 @@ func (as *adminServer) Start() error {
 func (as *adminServer) Shutdown(ctx context.Context) error {
 	as.logger.Info("Shutting down admin server")
 
-	// XXX consider moving the grace period to DBOSContext.Shutdown()
+	// Note: consider moving the grace period to DBOSContext.Shutdown()
 	ctx, cancel := context.WithTimeout(ctx, _ADMIN_SERVER_SHUTDOWN_TIMEOUT)
 	defer cancel()
 

dbos/system_database.go

@@ -1514,7 +1514,6 @@ func (s *sysDB) recv(ctx context.Context, input WorkflowRecvInput) (any, error)
 	functionName := "DBOS.recv"
 
 	// Get workflow state from context
-	// XXX these checks might be better suited for outside of the system db code. We'll see when we implement the client.
 	wfState, ok := ctx.Value(workflowStateKey).(*workflowState)
 	if !ok || wfState == nil {
 		return nil, newStepExecutionError("", functionName, "workflow state not found in context: are you running this step within a workflow?")
@@ -1534,7 +1533,6 @@ func (s *sysDB) recv(ctx context.Context, input WorkflowRecvInput) (any, error)
 	}
 
 	// Check if operation was already executed
-	// XXX this might not need to be in the transaction
 	checkInput := checkOperationExecutionDBInput{
 		workflowID: destinationID,
 		stepID:     stepID,
@@ -1561,7 +1559,6 @@ func (s *sysDB) recv(ctx context.Context, input WorkflowRecvInput) (any, error)
 	}
 	defer func() {
 		// Clean up the condition variable after we're done and broadcast to wake up any waiting goroutines
-		// XXX We should handle panics in this function and make sure we call this. Not a problem for now as panic will crash the importing package.
 		cond.Broadcast()
 		s.notificationsMap.Delete(payload)
 	}()
@@ -1576,7 +1573,6 @@ func (s *sysDB) recv(ctx context.Context, input WorkflowRecvInput) (any, error)
 	}
 	if !exists {
 		// Wait for notifications using condition variable with timeout pattern
-		// XXX should we prevent zero or negative timeouts?
 		s.logger.Debug("Waiting for notification on condition variable", "payload", payload)
 
 		done := make(chan struct{})
@@ -1796,7 +1792,7 @@ func (s *sysDB) getEvent(ctx context.Context, input WorkflowGetEventInput) (any,
 		return nil, fmt.Errorf("failed to query workflow event: %w", err)
 	}
 
-	if err == pgx.ErrNoRows || valueString == nil { // XXX valueString should never be `nil`
+	if err == pgx.ErrNoRows || valueString == nil { // valueString should never be `nil`
 		// Wait for notification with timeout using condition variable
 		done := make(chan struct{})
 		go func() {

dbos/workflow.go

@@ -201,7 +201,7 @@ func (h *workflowPollingHandle[R]) GetResult() (R, error) {
 			}
 			recordResultErr := h.dbosContext.(*dbosContext).systemDB.recordChildGetResult(h.dbosContext, recordGetResultInput)
 			if recordResultErr != nil {
-				// XXX do we want to fail this?
+				// Note: we might want GetResult to return this error if it happens, instead of returning the real error to the program.
 				h.dbosContext.(*dbosContext).logger.Error("failed to record get result", "error", recordResultErr)
 			}
 		}
@@ -282,7 +282,7 @@ func registerScheduledWorkflow(ctx DBOSContext, workflowName string, fn Workflow
 			// Use Next if Prev is not set, which will only happen for the first run
 			scheduledTime = entry.Next
 		}
-		wfID := fmt.Sprintf("sched-%s-%s", workflowName, scheduledTime) // XXX we can rethink the format
+		wfID := fmt.Sprintf("sched-%s-%s", workflowName, scheduledTime)
 		opts := []WorkflowOption{
 			WithWorkflowID(wfID),
 			WithQueue(_DBOS_INTERNAL_QUEUE_NAME),

dbos/workflows_test.go

@@ -1414,7 +1414,7 @@ func TestSendRecv(t *testing.T) {
 		if result != "message1-message2-message3" {
 			t.Fatalf("expected received message to be 'message1-message2-message3', got '%s'", result)
 		}
-		// XXX This is not a great condition: when all the tests run there's quite some randomness to this
+		// FIXME This is not a great condition: when all the tests run there's quite some randomness to this
 		if time.Since(start) > 10*time.Second {
 			t.Fatalf("receive workflow took too long to complete, expected < 5s, got %v", time.Since(start))
 		}
@@ -2895,7 +2895,7 @@ func TestWorkflowTimeout(t *testing.T) {
 		}
 
 		// Check the deadline on the status was is within an expected range (start time + timeout * .1)
-		// XXX this might be flaky and frankly not super useful
+		// FIXME this might be flaky and frankly not super useful
 		expectedDeadline := start.Add(timeout * 10 / 100)
 		if status.Deadline.Before(expectedDeadline) || status.Deadline.After(start.Add(timeout)) {
 			t.Fatalf("expected workflow deadline to be within %v and %v, got %v", expectedDeadline, start.Add(timeout), status.Deadline)