Exec UI failing when job.ID != job.Name

[PouuleT]

Nomad version

Output from nomad version

Nomad v0.11.1

Operating system and Environment details

Debian buster

Issue

I am running a job:
ID: f5e3edd3-deeb-46ed-a4d4-2852c3a7a5bd
Name: w000t.f5e3edd3-deeb-46ed-a4d4-2852c3a7a5bd

When trying to use the new Exec feature from the UI, I get on the job view:
https://server/ui/jobs/f5e3edd3-deeb-46ed-a4d4-2852c3a7a5bd

When I click on "Exec", a pop up opens with this:

URL of the popup :
https://server/ui/exec/w000t.f5e3edd3-deeb-46ed-a4d4-2852c3a7a5bd

If I manually change the URL to https://server/ui/exec/f5e3edd3-deeb-46ed-a4d4-2852c3a7a5bd , everything runs correctly, the Exec page is loaded and working

Reproduction steps

Create a Job with an ID that is not the same as the Name ( I do it with the golang library using this method )
Go to the web UI, try to "Exec" in the job, you'll see that the UI is trying to load the job by its name rather than its ID

Nomad Server logs

Apr 27 17:16:44 host-1 nomad[2782]:     2020-04-27T17:16:44.968+0200 [ERROR] http: request failed: method=GET path=/v1/job/w000t.f5e3edd3-deeb-46ed-a4d4-2852c3a7a5bd error="job not found" code=404

[backspace]

Thanks for letting us know about this, I should be able to check it out this week. 💞

[PouuleT]

I couldn't find a place in the doc explaining the difference between Name and ID, so when implementing a new Job with the api.NewServiceJob method, I thought I'd use a UUID as the ID, and something more meaningful like service_type.UUID, and everything was working fine so it was great, until now!

When digging into the code while trying to understand the issue, I noticed that in many places, job ID is substituted by job Name.

In the API for example, sometimes the variable is called jobName

nomad/command/agent/job_endpoint.go

Line 66 in 51b6ba8

return s.jobSummaryRequest(resp, req, jobName)

While in reality it is used as an ID

nomad/command/agent/job_endpoint.go

Line 630 in 51b6ba8

JobID: name,

In the UI, take a job_name parameter

nomad/ui/app/router.js

Line 18 in 51b6ba8

this.route('job', { path: '/:job_name' }, function() {

And rename it to ID in order to find the object

nomad/ui/app/routes/exec.js

Line 19 in 51b6ba8

const fullId = JSON.stringify([name, namespace || 'default']);

In the tests of the API, the mock Job has an ID != Name so everything is working and tested as it should be
On the UI side however, I saw that the "mock" job has the ID = Name

nomad/ui/mirage/factories/job.js

Lines 17 to 19 in 51b6ba8

	name() {
	return this.id;
	},

Indeed, if you change the id to something different than the name, you'll notice that the tests for the "Exec" UI ( and some others ) will fail

So I don't know how to handle this issue, I began working on a fix for the Exec, and then I saw that the job.Name vs job.ID swap is bigger than just the Exec feature.
Is it worth trying to rename jobName to jobID ( when the name is not matching the reality ) in the whole codebase?

[github-actions]

I'm going to lock this issue because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.