1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/*
* Copyright (c) 2022 AtLarge Research
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package org.opendc.web.server.model;
import io.hypersistence.utils.hibernate.type.json.JsonType;
import io.quarkus.hibernate.orm.panache.Panache;
import io.quarkus.hibernate.orm.panache.PanacheEntityBase;
import io.quarkus.hibernate.orm.panache.PanacheQuery;
import jakarta.persistence.*;
import jakarta.persistence.Column;
import jakarta.persistence.Entity;
import jakarta.persistence.EnumType;
import jakarta.persistence.Enumerated;
import jakarta.persistence.FetchType;
import jakarta.persistence.ForeignKey;
import jakarta.persistence.JoinColumn;
import jakarta.persistence.ManyToOne;
import jakarta.persistence.Table;
import java.time.Instant;
import java.util.Map;
import org.hibernate.annotations.Type;
import org.opendc.web.proto.JobState;
/**
* A simulation job to be run by the simulator.
*/
@Entity
@Table
public class Job extends PanacheEntityBase {
/**
* The main ID of a project.
* The value starts at 6 to account for the other 5 projects already made by the loading script.
*/
@Id
@SequenceGenerator(name = "jobSeq", sequenceName = "job_id_seq", allocationSize = 1, initialValue = 3)
@GeneratedValue(generator = "jobSeq")
public Long id;
@ManyToOne(optional = false, fetch = FetchType.EAGER)
@JoinColumn(name = "scenario_id", foreignKey = @ForeignKey(name = "fk_jobs_scenario"), nullable = false)
public Scenario scenario;
@Column(name = "created_by", nullable = false, updatable = false)
public String createdBy;
@Column(name = "created_at", nullable = false, updatable = false)
public Instant createdAt;
/**
* The instant at which the job started running.
*/
@Column(name = "started_at")
public Instant startedAt;
/**
* The number of simulation runs to perform.
*/
@Column(nullable = false, updatable = false)
public int repeats;
/**
* The instant at which the job was updated.
*/
@Column(name = "updated_at", nullable = false)
public Instant updatedAt;
/**
* The state of the job.
*/
@Enumerated(EnumType.STRING)
@Column(nullable = false)
public JobState state = JobState.PENDING;
/**
* The runtime of the job (in seconds).
*/
@Column(nullable = false)
public int runtime = 0;
/**
* Experiment results in JSON
*/
@Column(columnDefinition = "jsonb")
@Type(JsonType.class)
public Map<String, ?> results = null;
/**
* Job report containing warnings and errors in JSON
*/
@Column(columnDefinition = "jsonb")
@Type(JsonType.class)
public Map<String, Object> report = null;
/**
* Construct a {@link Job} instance.
*/
public Job(Scenario scenario, String createdBy, Instant createdAt, int repeats) {
this.createdBy = createdBy;
this.scenario = scenario;
this.createdAt = createdAt;
this.updatedAt = createdAt;
this.repeats = repeats;
}
/**
* JPA constructor
*/
protected Job() {}
/**
* Find {@link Job}s in the specified {@link JobState}.
*
* @param state The state of the jobs to find.
* @return A query for jobs that are in the specified state.
*/
public static PanacheQuery<Job> findByState(JobState state) {
return find("state", state);
}
/**
* Atomically update this job.
*
* @param newState The new state to enter into.
* @param time The time at which the update occurs.
* @param startedAt The time at which the job started running (optional).
* @param runtime The runtime (in seconds) consumed by the simulation job so far.
* @param results The results to possible set.
* @param report The report to possible set.
* @return <code>true</code> when the update succeeded`, <code>false</code> when there was a conflict.
*/
public boolean updateAtomically(
JobState newState,
Instant time,
Instant startedAt,
int runtime,
Map<String, ?> results,
Map<String, Object> report) {
// Update entity fields directly - this uses the JsonType converter for proper JSON serialization
this.state = newState;
this.updatedAt = time;
if (startedAt != null) {
this.startedAt = startedAt;
}
this.runtime = runtime;
this.results = results;
this.report = report;
// Flush changes to database - JsonType will properly serialize the results map to JSON
Panache.getEntityManager().flush();
return true;
}
/**
* Determine whether the job is allowed to transition to <code>newState</code>.
*
* @param newState The new state to transition to.
* @return <code>true</code> if the transition to the new state is legal, <code>false</code> otherwise.
*/
public boolean canTransitionTo(JobState newState) {
// Note that we always allow transitions from the state
return newState == this.state
|| switch (this.state) {
case PENDING -> newState == JobState.CLAIMED;
case CLAIMED -> newState == JobState.RUNNING || newState == JobState.FAILED;
case RUNNING -> newState == JobState.FINISHED || newState == JobState.FAILED;
case FINISHED, FAILED -> false;
};
}
}
|
