Bug #17299: [controller] runtime_constraints should be spelled {API:true}, not {api:true} - Arvados

Bug #17299

[controller] runtime_constraints should be spelled {API:true}, not {api:true}

Added by Tom Clegg 9 months ago. Updated 6 months ago.

Status:

Resolved

Priority:

Normal

Assigned To:

Nico César

Category:

Target version:

2021-02-03 Sprint

Start date:

02/03/2021

Due date:

% Done:

100%

Estimated time:

(Total: 0.00 h)

Story points:

Release:

Arvados 2.2.0

Release relationship:

Auto

Description

In #17014 3ec51dcf456b2afe02857089895a261653abddd4 did this

 type RuntimeConstraints struct {
-       API          *bool
+       API          bool  `json:"api"`

and this

+    self.runtime_constraints = {
+      'api' => false,
+      'keep_cache_ram' => 0,
+      'ram' => 0,
+      'vcpus' => 0,
+    }.merge(attributes['runtime_constraints'] || {})

As a result:

when a client submits a CR with {"runtime_constraints":{"API":true}}, controller changes it to {"api":true}
when railsapi loads a CR from the database that has {"API":true}, it merges with the default {"api":false} and returns {"api":false,"API":true} to the caller and/or the updated database row, which is obviously bad and (sometimes?) causes crunchrun to use the wrong value.

To fix:

change the key back to "API" in the Go SDK
change the key to "API" in the Rails merge-with-default code

A benefit of #17014 is that (with the above fix) railsapi won't see "api" no matter what the client sends -- controller will rewrite it as "API" -- so we shouldn't need any extra checks to prevent future problems.

Subtasks