JobsController.java

package edu.ucsb.cs156.courses.controllers;

import com.fasterxml.jackson.core.JsonProcessingException;

import com.fasterxml.jackson.databind.ObjectMapper;

import edu.ucsb.cs156.courses.collections.ConvertedSectionCollection;

import edu.ucsb.cs156.courses.entities.Job;

import edu.ucsb.cs156.courses.errors.EntityNotFoundException;

import edu.ucsb.cs156.courses.jobs.TestJob;

import edu.ucsb.cs156.courses.jobs.UpdateCourseDataJobFactory;

import edu.ucsb.cs156.courses.jobs.UploadGradeDataJob;

import edu.ucsb.cs156.courses.jobs.UploadGradeDataJobFactory;

import edu.ucsb.cs156.courses.repositories.JobsRepository;

import edu.ucsb.cs156.courses.services.jobs.JobService;

import io.swagger.v3.oas.annotations.Operation;

import io.swagger.v3.oas.annotations.Parameter;

import io.swagger.v3.oas.annotations.tags.Tag;

import java.util.Arrays;

import java.util.List;

import java.util.Map;

import lombok.extern.slf4j.Slf4j;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.data.domain.Page;

import org.springframework.data.domain.PageRequest;

import org.springframework.data.domain.Sort.Direction;

import org.springframework.security.access.prepost.PreAuthorize;

import org.springframework.web.bind.annotation.DeleteMapping;

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.RequestMapping;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.bind.annotation.RestController;

@Tag(name = "Jobs")

@RequestMapping("/api/jobs")

@RestController

  @Autowired private JobsRepository jobsRepository;

  @Autowired private ConvertedSectionCollection convertedSectionCollection;

  @Autowired private JobService jobService;

  @Autowired ObjectMapper mapper;

  @Autowired UpdateCourseDataJobFactory updateCourseDataJobFactory;

  @Autowired UploadGradeDataJobFactory updateGradeDataJobFactory;

  @Operation(summary = "List all jobs")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @GetMapping("/all")

  public Iterable<Job> allJobs() {

  }

  @Operation(summary = "Get a paginated list of jobs")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @GetMapping(value = "/paged", produces = "application/json")

  public Page<Job> someJobs(

      @Parameter(

              name = "page",

              description = "what page of the data",

              example = "0",

              required = true)

          @RequestParam

          int page,

      @Parameter(

              name = "pageSize",

              description = "size of each page",

              example = "5",

              required = true)

          @RequestParam

          int pageSize,

      @Parameter(

              name = "sortField",

              description = "sort field",

              example = "createdAt",

              required = false)

          @RequestParam(defaultValue = "createdAt")

          String sortField,

      @Parameter(

              name = "sortDirection",

              description = "sort direction",

              example = "ASC",

              required = false)

          @RequestParam(defaultValue = "ASC")

          String sortDirection) {

              "%s is not a valid sort field.  Valid values are %s", sortField, allowedSortFields));

    }

              "%s is not a valid sort direction.  Valid values are %s",

              sortDirection, allowedSortDirections));

    }

    }

  }

  @Operation(summary = "Delete all job records")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @DeleteMapping("/all")

  public Map<String, String> deleteAllJobs() {

  }

  @Operation(summary = "Get a specific Job Log by ID if it is in the database")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @GetMapping("")

  public Job getJobLogById(

      @Parameter(name = "id", description = "ID of the job") @RequestParam Long id)

      throws JsonProcessingException {

  }

  @Operation(summary = "Delete specific job record")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @DeleteMapping("")

  public Map<String, String> deleteAllJobs(@Parameter(name = "id") @RequestParam Long id) {

    }

  }

  @Operation(summary = "Launch Test Job (click fail if you want to test exception handling)")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @PostMapping("/launch/testjob")

  public Job launchTestJob(

      @Parameter(name = "fail") @RequestParam Boolean fail,

      @Parameter(name = "sleepMs") @RequestParam Integer sleepMs) {

  }

  @Operation(summary = "Launch Job to Update Course Data")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @PostMapping("/launch/updateCourses")

  public Job launchUpdateCourseDataJob(

      @Parameter(name = "quarterYYYYQ", description = "quarter (YYYYQ format)") @RequestParam

          String quarterYYYYQ,

      @Parameter(name = "subjectArea") @RequestParam String subjectArea,

      @Parameter(

              name = "ifStale",

              description = "true if job should only update when data is stale")

          @RequestParam(defaultValue = "true")

          Boolean ifStale) {

        "launchUpdateCourseDataJob: quarterYYYYQ={}, subjectArea={}, ifStale={}",

        quarterYYYYQ,

        subjectArea,

        ifStale);

  }

  @Operation(summary = "Launch Job to Update Course Data using Quarter")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @PostMapping("/launch/updateQuarterCourses")

  public Job launchUpdateCourseDataWithQuarterJob(

      @Parameter(name = "quarterYYYYQ", description = "quarter (YYYYQ format)") @RequestParam

          String quarterYYYYQ,

      @Parameter(

              name = "ifStale",

              description = "true if job should only update when data is stale")

          @RequestParam(defaultValue = "true")

          Boolean ifStale) {

  }

  @Operation(summary = "Get long job logs")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @GetMapping("/logs/{id}")

  public String getJobLogs(@Parameter(name = "id", description = "Job ID") @PathVariable Long id) {

  }

  @Operation(summary = "Launch Job to Update Course Data for range of quarters")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @PostMapping("/launch/updateCoursesRangeOfQuarters")

  public Job launchUpdateCourseDataRangeOfQuartersJob(

      @Parameter(name = "start_quarterYYYYQ", description = "start quarter (YYYYQ format)")

          @RequestParam

          String start_quarterYYYYQ,

      @Parameter(name = "end_quarterYYYYQ", description = "end quarter (YYYYQ format)")

          @RequestParam

          String end_quarterYYYYQ,

      @Parameter(

              name = "ifStale",

              description = "true if job should only update when data is stale")

          @RequestParam(defaultValue = "true")

          Boolean ifStale) {

  }

  @Operation(

      summary = "Launch Job to Update Course Data for a range of quarters for a single subject")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @PostMapping("/launch/updateCoursesRangeOfQuartersSingleSubject")

  public Job launchUpdateCourseDataRangeOfQuartersSingleSubjectJob(

      @Parameter(name = "subjectArea", description = "subject area") @RequestParam

          String subjectArea,

      @Parameter(name = "start_quarterYYYYQ", description = "start quarter (YYYYQ format)")

          @RequestParam

          String start_quarterYYYYQ,

      @Parameter(name = "end_quarterYYYYQ", description = "end quarter (YYYYQ format)")

          @RequestParam

          String end_quarterYYYYQ,

      @Parameter(

              name = "ifStale",

              description = "true if job should only update when data is stale")

          @RequestParam(defaultValue = "true")

          Boolean ifStale) {

  }

  @Operation(summary = "Launch Job to update grade history")

  @PreAuthorize("hasRole('ROLE_ADMIN')")

  @PostMapping("/launch/uploadGradeData")

  public Job launchUploadGradeData() {

  }

}

Mutations