-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathRawResponseController.java
More file actions
355 lines (326 loc) · 19.8 KB
/
Copy pathRawResponseController.java
File metadata and controls
355 lines (326 loc) · 19.8 KB
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
package fr.insee.genesis.controller.rest.responses;
import fr.insee.genesis.controller.dto.rawdata.LunaticJsonRawDataUnprocessedDto;
import fr.insee.genesis.controller.utils.DateTimeUtils;
import fr.insee.genesis.domain.model.surveyunit.Mode;
import fr.insee.genesis.domain.model.surveyunit.rawdata.DataProcessResult;
import fr.insee.genesis.domain.model.surveyunit.rawdata.LunaticJsonRawDataModel;
import fr.insee.genesis.domain.model.surveyunit.rawdata.RawResponseModel;
import fr.insee.genesis.domain.ports.api.LunaticJsonRawDataApiPort;
import fr.insee.genesis.domain.ports.api.RawResponseApiPort;
import fr.insee.genesis.exceptions.GenesisError;
import fr.insee.genesis.exceptions.GenesisException;
import fr.insee.genesis.exceptions.NoDataException;
import fr.insee.genesis.infrastructure.repository.RawResponseInputRepository;
import fr.insee.modelefiliere.RawResponseDto;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PagedModel;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import java.time.Instant;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
@Slf4j
@Controller
@RequiredArgsConstructor
public class RawResponseController {
private static final String SUCCESS_MESSAGE = "Interrogation %s saved";
private static final String INTERROGATION_ID = "interrogationId";
private final LunaticJsonRawDataApiPort lunaticJsonRawDataApiPort;
private final RawResponseApiPort rawResponseApiPort;
private final RawResponseInputRepository rawRepository;
@Operation(summary = "Save lunatic json data from one interrogation in Genesis Database")
@PutMapping(path = "/responses/raw/lunatic-json/save")
@PreAuthorize("hasRole('COLLECT_PLATFORM')")
public ResponseEntity<String> saveRawResponsesFromJsonBody(
@RequestParam("campaignName") String campaignName,
@RequestParam("questionnaireId") String questionnaireId,
@RequestParam(INTERROGATION_ID) String interrogationId,
@RequestParam(value = "surveyUnitId", required = false) String idUE,
@RequestParam(value = "mode") Mode modeSpecified,
@RequestBody Map<String, Object> dataJson
) throws GenesisException{
log.info("Try to save interrogationId {} for campaign {}", interrogationId, campaignName);
LunaticJsonRawDataModel rawData = LunaticJsonRawDataModel.builder()
.campaignId(campaignName)
.questionnaireId(questionnaireId.toUpperCase())
.interrogationId(interrogationId)
.idUE(idUE)
.mode(modeSpecified)
.data(dataJson)
.recordDate(LocalDateTime.now())
.build();
lunaticJsonRawDataApiPort.save(rawData);
log.info("Data saved for interrogationId {} and campaign {}", interrogationId, campaignName);
// Collect platform prefer code 201 in case of success
return ResponseEntity.status(201).body(String.format(SUCCESS_MESSAGE, interrogationId));
}
@Operation(summary = "Save lunatic json data from one interrogation in Genesis Database (with json " +
"schema validation)")
@PostMapping(path="/raw-responses")
@PreAuthorize("hasRole('COLLECT_PLATFORM')")
public ResponseEntity<String> saveRawResponsesFromRawResponseDto(
@Valid @RequestBody RawResponseDto dto
) {
rawRepository.saveAsRawJson(dto); //TODO put in service, repository is infra layer
return ResponseEntity.status(201).body(String.format(SUCCESS_MESSAGE, dto.getInterrogationId()));
}
@Operation(summary = "Get a raw response by collection instrument ID and interrogation ID")
@GetMapping("/raw-responses/collection-instruments/{collectionInstrumentId}/interrogations/{interrogationId}")
@PreAuthorize("hasRole('ADMIN')")
public ResponseEntity<List<RawResponseModel>> getRawResponse(
@PathVariable String collectionInstrumentId,
@PathVariable String interrogationId
) throws NoDataException {
return ResponseEntity.ok(rawResponseApiPort.getRawResponseByCollectionInstrumentIdAndInterrogationId(collectionInstrumentId, interrogationId));
}
//PROCESS
@Operation(summary = "Process raw data for a list of interrogations")
@PostMapping(path = "/raw-responses/process")
@PreAuthorize("hasRole('SCHEDULER')")
public ResponseEntity<String> processRawResponses(
@Parameter(
description = "Id of the collection instrument (old questionnaireId)",
example = "ENQTEST2025X00"
)
@RequestParam("collectionInstrumentId") String collectionInstrumentId,
@RequestBody List<String> interrogationIdList
) throws GenesisException{
log.info("Try to process raw responses for collectionInstrumentId {} and {} interrogationIds",
collectionInstrumentId, interrogationIdList.size());
List<GenesisError> errors = new ArrayList<>();
DataProcessResult result = rawResponseApiPort.processRawResponsesByInterrogationIds(
collectionInstrumentId, interrogationIdList, errors
);
return ResponseEntity.ok(result.message(collectionInstrumentId));
}
@Operation(summary = "Process raw data for all data of an collection instrument")
@PostMapping(path = "/raw-responses/{collectionInstrumentId}/process")
@PreAuthorize("hasRole('SCHEDULER')")
public ResponseEntity<String> processRawResponsesByCollectionInstrumentId(
@Parameter(
description = "Id of the collection instrument (old questionnaireId)",
example = "ENQTEST2025X00"
)
@PathVariable("collectionInstrumentId") String collectionInstrumentId
) throws GenesisException{
log.info("Try to process raw responses for collectionInstrumentId {}", collectionInstrumentId);
DataProcessResult result = rawResponseApiPort.processRawResponsesByCollectionInstrumentId(collectionInstrumentId);
return ResponseEntity.ok(result.message(collectionInstrumentId));
}
@Operation(summary = "Get the list of collection instruments containing unprocessed interrogations")
@GetMapping(path = "/raw-responses/unprocessed/collection-instrument-ids")
@PreAuthorize("hasRole('SCHEDULER')")
public ResponseEntity<List<String>> getUnprocessedCollectionInstrument(){
log.info("Try to get collection instruments containing unprocessed interrogations...");
return ResponseEntity.ok(rawResponseApiPort.getUnprocessedCollectionInstrumentIds());
}
//GET unprocessed
@Operation(summary = "Get campaign id and interrogationId from all unprocessed raw json data")
@GetMapping(path = "/responses/raw/lunatic-json/get/unprocessed")
@PreAuthorize("hasRole('SCHEDULER')")
public ResponseEntity<List<LunaticJsonRawDataUnprocessedDto>> getUnprocessedJsonRawData() {
log.info("Try to get unprocessed raw JSON datas...");
return ResponseEntity.ok(lunaticJsonRawDataApiPort.getUnprocessedDataIds());
}
@Operation(summary = "Get campaign id and interrogationId from all unprocessed raw json data")
@GetMapping(path = "/responses/raw/lunatic-json/get/unprocessed/questionnaireIds")
@PreAuthorize("hasRole('SCHEDULER')")
public ResponseEntity<Set<String>> getUnprocessedJsonRawDataQuestionnairesIds() {
log.info("Try to get unprocessed raw JSON datas questionnaires...");
return ResponseEntity.ok(lunaticJsonRawDataApiPort.getUnprocessedDataQuestionnaireIds());
}
//PROCESS
@Operation(summary = "Process raw data of a questionnaire (old raw model)")
@PostMapping(path = "/responses/raw/lunatic-json/{questionnaireId}/process")
@PreAuthorize("hasRole('SCHEDULER')")
public ResponseEntity<String> processJsonRawData(
@PathVariable String questionnaireId
) throws GenesisException{
log.info("Try to process raw JSON datas for questionnaire {}",questionnaireId);
DataProcessResult result = lunaticJsonRawDataApiPort.processRawData(questionnaireId);
return result.formattedDataCount() == 0 ?
ResponseEntity.ok("%d document(s) processed".formatted(result.dataCount()))
: ResponseEntity.ok("%d document(s) processed, including %d FORMATTED after data verification"
.formatted(result.dataCount(), result.formattedDataCount()));
}
@Operation(summary = "Get processed data ids from last n hours (default 24h)")
@GetMapping(path = "/responses/raw/lunatic-json/processed/ids")
@PreAuthorize("hasRole('ADMIN')")
public ResponseEntity<Map<String, List<String>>> getProcessedDataIdsSinceHours(
@RequestParam("questionnaireId") String questionnaireId,
@RequestParam(name = "sinceHours", defaultValue = "24") int hours
) {
log.info("Retrieve ids of data processed in last {}h", hours);
Map<String, List<String>> result = lunaticJsonRawDataApiPort.findProcessedIdsgroupedByQuestionnaireSince(LocalDateTime.now().minusHours(hours).minusMinutes(10));
return ResponseEntity.ok(result);
}
@Operation(summary = "Get lunatic JSON data from one campaign in Genesis Database, filtered by start and end dates")
@GetMapping(path = "/responses/raw/lunatic-json/{campaignId}")
@PreAuthorize("hasRole('USER_BATCH_GENERIC')")
public ResponseEntity<PagedModel<LunaticJsonRawDataModel>> getLunaticJsonRawDataModelFromJsonBody(
@PathVariable String campaignId,
@RequestParam(value = "startDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "Start date in UTC", example = "2026-02-02T00:00:00Z")
Instant startDate,
@RequestParam(value = "localStartDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "Extract since in Europe/Paris timezone", schema = @Schema(type = "string", format = "date-time", example = "2026-02-02T01:00:00"))
LocalDateTime localStartDate,
@RequestParam(value = "endDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "End date in UTC", example = "2026-02-02T00:00:00Z")
Instant endDate,
@RequestParam(value = "localEndDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "Extract until in Europe/Paris timezone", schema = @Schema(type = "string", format = "date-time", example = "2026-02-02T01:00:00"))
LocalDateTime localEndDate,
@RequestParam(value = "page", defaultValue = "0") int page,
@RequestParam(value = "size", defaultValue = "1000") int size
) {
Instant resolvedStartDate = DateTimeUtils.resolveInstant(startDate, localStartDate);
Instant resolvedEndDate = DateTimeUtils.resolveInstant(endDate, localEndDate);
log.info(
"Try to read raw JSONs for campaign {} with startDateUtc={} startDateLocal={} endDateUtc={} endDateLocal={} - page={} - size={}",
campaignId,
resolvedStartDate,
DateTimeUtils.toFranceDateTime(resolvedStartDate),
resolvedEndDate,
DateTimeUtils.toFranceDateTime(resolvedEndDate),
page,
size
);
Pageable pageable = PageRequest.of(page, size);
Page<LunaticJsonRawDataModel> rawResponses = lunaticJsonRawDataApiPort.findRawDataByCampaignIdAndDate(campaignId, resolvedStartDate, resolvedEndDate, pageable);
log.info(
"rawResponses, lunatic-json for campaign {} with startDateUtc={} startDateLocal={} endDateUtc={} endDateLocal={} count={}",
campaignId,
resolvedStartDate,
DateTimeUtils.toFranceDateTime(resolvedStartDate),
resolvedEndDate,
DateTimeUtils.toFranceDateTime(resolvedEndDate),
rawResponses.getContent().size()
);
return ResponseEntity.status(HttpStatus.OK).body(new PagedModel<>(rawResponses));
}
@Operation(summary = "Get lunatic JSON data from one questionnaire in Genesis Database")
@GetMapping(path = "/responses/raw/lunatic-json/by-questionnaire/{questionnaireId}")
@PreAuthorize("hasRole('ADMIN')")
public ResponseEntity<PagedModel<LunaticJsonRawDataModel>> getLunaticJsonRawDataModelFromQuestionnaire(
@PathVariable String questionnaireId,
@RequestParam(value = "page", defaultValue = "0") int page,
@RequestParam(value = "size", defaultValue = "1000") int size
) {
log.info("Try to read raw lunatic JSONs for questionnaire {} - page={} - size={}", questionnaireId, page, size);
Pageable pageable = PageRequest.of(page, size);
Page<LunaticJsonRawDataModel> rawResponses = lunaticJsonRawDataApiPort.findRawDataByQuestionnaireId(questionnaireId, pageable);
log.info("rawResponses for questionnaire {} = {}",questionnaireId, rawResponses.getContent().size());
return ResponseEntity.status(HttpStatus.OK).body(new PagedModel<>(rawResponses));
}
@Operation(summary = "Get lunatic json data by questionnaire ID and interrogation ID")
@GetMapping("/responses/raw/lunatic-json/questionnaireIds/{questionnaireId}/interrogations/{interrogationId}")
@PreAuthorize("hasRole('ADMIN')")
public ResponseEntity<List<LunaticJsonRawDataModel>> getLunaticJsonData(
@PathVariable String questionnaireId,
@PathVariable String interrogationId
) throws NoDataException{
return ResponseEntity.ok(
lunaticJsonRawDataApiPort.getLunaticJsonDataByQuestionnaireIdAndInterrogationId(
questionnaireId,
interrogationId
)
);
}
@Operation(summary = "Check existence of an interrogation")
@RequestMapping(value = "/responses/raw/lunatic-json/{interrogationId}", method = RequestMethod.HEAD)
@PreAuthorize("hasAnyRole('ADMIN', 'COLLECT_PLATFORM')")
public ResponseEntity<Void> existsLunaticJsonByInterrogationId(@PathVariable String interrogationId) {
if (lunaticJsonRawDataApiPort.existsByInterrogationId(interrogationId)) {
return ResponseEntity.ok().build();
}
return ResponseEntity.notFound().build();
}
@Operation(summary = "Get rawResponse JSON data from one campaign in Genesis Database, filtered by start and end dates")
@GetMapping(path = "/raw-responses/{campaignId}")
@PreAuthorize("hasRole('USER_BATCH_GENERIC')")
public ResponseEntity<PagedModel<RawResponseModel>> getRawResponsesFromJsonBody(
@PathVariable String campaignId,
@RequestParam(value = "startDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "Start date in UTC", example = "2026-02-02T00:00:00Z")
Instant startDate,
@RequestParam(value = "localStartDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "Extract since in Europe/Paris timezone", schema = @Schema(type = "string", format = "date-time", example = "2026-02-02T01:00:00"))
LocalDateTime localStartDate,
@RequestParam(value = "endDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "End date in UTC", example = "2026-04-02T00:00:00Z")
Instant endDate,
@RequestParam(value = "localEndDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
@Parameter(description = "Extract until in Europe/Paris timezone", schema = @Schema(type = "string", format = "date-time", example = "2026-02-02T01:00:00"))
LocalDateTime localEndDate,
@RequestParam(value = "page", defaultValue = "0") int page,
@RequestParam(value = "size", defaultValue = "1000") int size
) {
Instant resolvedStartDate = DateTimeUtils.resolveInstant(startDate, localStartDate);
Instant resolvedEndDate = DateTimeUtils.resolveInstant(endDate, localEndDate);
log.info("Try to read raw JSONs for campaign {} with startDateUtc={} startDateLocal={} endDateUtc={} endDateLocal={} - page={} - size={}",
campaignId,
resolvedStartDate,
DateTimeUtils.toFranceDateTime(resolvedStartDate),
resolvedEndDate,
DateTimeUtils.toFranceDateTime(resolvedEndDate),
page,
size
);
Pageable pageable = PageRequest.of(page, size);
Page<RawResponseModel> rawResponses = rawResponseApiPort.findRawResponseDataByCampaignIdAndDate(campaignId, resolvedStartDate, resolvedEndDate, pageable);
log.info("rawResponses for campaign {},with startDateUtc={} startDateLocal={} endDateUtc={} endDateLocal={} count={}",
campaignId,
resolvedStartDate,
DateTimeUtils.toFranceDateTime(resolvedStartDate),
resolvedEndDate,
DateTimeUtils.toFranceDateTime(resolvedEndDate),
rawResponses.getContent().size());
return ResponseEntity.status(HttpStatus.OK).body(new PagedModel<>(rawResponses));
}
@Operation(summary = "Get rawResponse JSON data from one collection instrument in Genesis Database")
@GetMapping(path = "/raw-responses/by-collection-instrument/{collectionInstrumentId}")
@PreAuthorize("hasRole('ADMIN')")
public ResponseEntity<PagedModel<RawResponseModel>> getRawResponsesFromCollectionInstrumentId(
@PathVariable String collectionInstrumentId,
@RequestParam(value = "page", defaultValue = "0") int page,
@RequestParam(value = "size", defaultValue = "1000") int size
) {
log.info("Try to read raw JSONs for collectionInstrument {} - page={} - size={}", collectionInstrumentId, page, size);
Pageable pageable = PageRequest.of(page, size);
Page<RawResponseModel> rawResponses = rawResponseApiPort.findRawResponseDataByCollectionInstrumentId(collectionInstrumentId, pageable);
log.info("rawResponses={}", rawResponses.getContent().size());
return ResponseEntity.status(HttpStatus.OK).body(new PagedModel<>(rawResponses));
}
@Operation(summary = "Check existence of an interrogation")
@RequestMapping(value = "/raw-responses/{interrogationId}", method = RequestMethod.HEAD)
@PreAuthorize("hasAnyRole('ADMIN', 'COLLECT_PLATFORM')")
public ResponseEntity<Void> exists(@PathVariable String interrogationId) {
if (rawResponseApiPort.existsByInterrogationId(interrogationId)) {
return ResponseEntity.ok().build();
}
return ResponseEntity.notFound().build();
}
}