grahamc/hydra - Change P32OJ3RUWL2CQFC3AHG2OC3SQKBSYOXNMPWOQHHALKC7ENHYFJ3QC

Jobsets: update schema to align with the API

To further align with the API, we return custom JSON in order to display a visible field rather than hidden – a PUT request expects visible, while a GET request returns hidden.

This also allows us to rename the jobsetinputs field to inputs for the same reason: PUT expects inputs, while GET returns jobsetinputs.

Created by Cole Helbling on April 28, 2021

P32OJ3RUWL2CQFC3AHG2OC3SQKBSYOXNMPWOQHHALKC7ENHYFJ3QC

Dependencies

In channels

main

upstream

Change contents

Replacement in hydra-api.yaml at line 645 [5.545]

B:BD[2.1172] → [2.1172:1264]

        hidden:
          description: when false the jobset is visible in the web frontend

[2.1172]

[2.1264]

        visible:
          description: when true the jobset is visible in the web frontend

Replacement in hydra-api.yaml at line 670 [5.545]
B:BD[2.2028] → [2.2028:2051]
```
          type: string
```
[2.2028]
[2.2051]
```
          type: integer
```
Replacement in hydra-api.yaml at line 675 [5.545]
B:BD[5.15928] → [5.15928:15950]
```
        jobsetinputs:
```
[5.15806]
[5.15950]
```
        inputs:
```

Replacement in src/lib/Hydra/Controller/Jobset.pm at line 273 [7.104]

B:BD[6.500] → [2.2173:2320]

        foreach my $name (keys %{$c->stash->{params}->{jobsetinputs}}) {
            my $inputData = $c->stash->{params}->{jobsetinputs}->{$name};

[6.500]

[6.635]

        foreach my $name (keys %{$c->stash->{params}->{inputs}}) {
            my $inputData = $c->stash->{params}->{inputs}->{$name};

Replacement in src/lib/Hydra/Schema/Jobsets.pm at line 413 [10.1960]

∅:D[8.427] → [9.1:14]

B:BD[9.1] → [9.1:14]

B:BD[9.14] → [11.137:154]

B:BD[11.154] → [2.2321:2392]

∅:D[2.2392] → [11.154:173]

B:BD[11.154] → [11.154:173]

B:BD[11.173] → [2.2393:2620]

∅:D[2.2620] → [11.173:193]

B:BD[11.173] → [11.173:193]

B:BD[11.218] → [12.0:25]

B:BD[12.25] → [2.2621:2750]

∅:D[12.71] → [11.242:249]

∅:D[2.2750] → [11.242:249]

B:BD[11.242] → [11.242:249]

∅:D[11.249] → [13.330:355]

B:BD[9.14] → [13.330:355]

∅:D[13.355] → [9.33:73]

B:BD[9.33] → [9.33:73]

my %hint = (
    columns => [
        "errortime",
        "lastcheckedtime",
        "triggertime",
        "enabled",
        "keepnr",
        "checkinterval",
        "schedulingshares",
        "starttime"
    ],
    string_columns => [
        "name",
        "project",
        "description",
        "nixexprinput",
        "nixexprpath",
        "errormsg",
        "emailoverride",
        "fetcherrormsg",
        "type",
        "flake"
    ],
    boolean_columns => [
        "enableemail",
        "hidden"
    ],
    eager_relations => {
        jobsetinputs => "name"
    }
);

[8.218]

[14.2105]

sub as_json {
    my $self = shift;

Replacement in src/lib/Hydra/Schema/Jobsets.pm at line 416 [10.1960]

B:BD[14.2106] → [9.74:109]

sub json_hint {
    return \%hint;

[14.2106]

[9.109]

    my %json = (
        # columns
        "errortime" => $self->get_column("errortime"),
        "lastcheckedtime" => $self->get_column("lastcheckedtime"),
        "triggertime" => $self->get_column("triggertime"),
        "enabled" => $self->get_column("enabled"),
        "keepnr" => $self->get_column("keepnr"),
        "checkinterval" => $self->get_column("checkinterval"),
        "schedulingshares" => $self->get_column("schedulingshares"),
        "starttime" => $self->get_column("starttime"),
        # string_columns
        "name" => $self->get_column("name") // "",
        "project" => $self->get_column("project") // "",
        "description" => $self->get_column("description") // "",
        "nixexprinput" => $self->get_column("nixexprinput") // "",
        "nixexprpath" => $self->get_column("nixexprpath") // "",
        "errormsg" => $self->get_column("errormsg") // "",
        "emailoverride" => $self->get_column("emailoverride") // "",
        "fetcherrormsg" => $self->get_column("fetcherrormsg") // "",
        "type" => $self->get_column("type") // "",
        "flake" => $self->get_column("flake") // "",
        # boolean_columns
        "enableemail" => $self->get_column("enableemail") ? JSON::true : JSON::false,
        "visible" => $self->get_column("hidden") ? JSON::false : JSON::true,
        "inputs" => { map { $_->name => $_ } $self->jobsetinputs }
    );
    return \%json;

Replacement in src/root/edit-jobset.tt at line 49 [15.367]

B:BD[15.1864] → [2.2751:2903]

    <tbody class="jobsetinputs">
      [% jobsetinputs = createFromEval ? eval.jobsetevalinputs : jobset.jobsetinputs; FOREACH input IN jobsetinputs %]

[15.1864]

[16.175]

    <tbody class="inputs">
      [% inputs = createFromEval ? eval.jobsetevalinputs : jobset.jobsetinputs; FOREACH input IN inputs %]

Replacement in src/root/edit-jobset.tt at line 223 [15.367]

B:BD[17.409] → [2.3116:3182]

    var data = { 'jobsetinputs': {} };
    var jobsetinputs = {};

[17.409]

[18.1152]

    var data = { 'inputs': {} };
    var inputs = {};

Replacement in src/root/edit-jobset.tt at line 236 [15.367]

B:BD[17.824] → [2.3183:3265]

        if (!(baseName in jobsetinputs))
            jobsetinputs[baseName] = {};

[17.824]

[17.906]

        if (!(baseName in inputs))
            inputs[baseName] = {};

Replacement in src/root/edit-jobset.tt at line 240 [15.367]

B:BD[18.1319] → [2.3266:3334]

            data.jobsetinputs[elem.value] = jobsetinputs[baseName];

[18.1319]

[18.1320]

            data.inputs[elem.value] = inputs[baseName];

Replacement in src/root/edit-jobset.tt at line 242 [15.367]

B:BD[18.1333] → [2.3335:3391]

            jobsetinputs[baseName][param] = elem.value;

[18.1333]

[17.1072]

            inputs[baseName][param] = elem.value;

Replacement in t/Controller/Jobset/http.t at line 49 [3.1]
B:BD[3.1367] → [3.1367:1389]
```
        visible => 1,
```
[3.1367]
[3.1389]
```
        visible => JSON::true,
```

Replacement in t/Controller/Jobset/http.t at line 79 [3.1]

B:BD[3.2178] → [3.2178:2231]

     hidden => JSON::false,
     jobsetinputs => {},

[3.2178]

[3.2231]

     visible => JSON::true,
     inputs => {},

Replacement in t/Controller/Jobset/http.t at line 102 [3.1]
B:BD[3.2746] → [3.2746:2768]
```
        visible => 1,
```
[3.2746]
[3.2768]
```
        visible => JSON::true,
```
Replacement in t/Controller/Jobset/http.t at line 107 [3.1]
B:BD[3.2882] → [3.2882:2908]
```
        jobsetinputs => {
```
[3.2882]
[3.2908]
```
        inputs => {
```

Replacement in t/Controller/Jobset/http.t at line 137 [3.1]

B:BD[3.3665] → [3.3665:3714]

    hidden => JSON::false,
    jobsetinputs => {

[3.3665]

[3.3714]

    visible => JSON::true,
    inputs => {

Replacement in t/Controller/Jobset/http.t at line 143 [3.1]

B:BD[3.3822] → [3.3822:3918]

        jobsetinputalts => [
          "https://github.com/NixOS/ofborg.git released"
        ]

[3.3822]

[3.3918]

        value => "https://github.com/NixOS/ofborg.git released"

Replacement in t/api-test.t at line 84 [19.36450]

B:BD[4.1378] → [4.1378:1660]

    my $result = request_json({ uri => '/jobset/sample/default', method => 'PUT', data => { nixexprpath => "default.nix", nixexprinput => "my-src", jobsetinputs => { "my-src" => { type => "path", value => $jobsetdir } }, enabled => "1", visible => "1", checkinterval => "3600"} });

[4.1378]

[4.1660]

    my $result = request_json({ uri => '/jobset/sample/default', method => 'PUT', data => { nixexprpath => "default.nix", nixexprinput => "my-src", inputs => { "my-src" => { type => "path", value => $jobsetdir } }, enabled => "1", visible => "1", checkinterval => "3600"} });

Replacement in t/api-test.t at line 89 [19.36450]

B:BD[19.38310] → [4.1819:1910]

    ok(exists $jobset->{jobsetinputs}->{"my-src"}, "The new jobset has a 'my-src' input");

[19.38310]

[9.228]

    ok(exists $jobset->{inputs}->{"my-src"}, "The new jobset has a 'my-src' input");

Replacement in t/api-test.t at line 91 [19.36450]

B:BD[9.229] → [4.1911:2033]

    is($jobset->{jobsetinputs}->{"my-src"}->{"jobsetinputalts"}->[0], $jobsetdir, "The 'my-src' input is in $jobsetdir");

[9.229]

[4.2033]

    is($jobset->{inputs}->{"my-src"}->{value}, $jobsetdir, "The 'my-src' input is in $jobsetdir");