Add RuntimeJob model

[akihikokuroda]

Summary

Fix #1163

Details and comments

This PR has

1. add RuntimeJob model
2. add API: /api/v1/runtime_jobs/utils/create_runtimejob/ with job id and runtime job id as argument. It creates a RuntimeJob table entry
3. add API: /api/v1/runtime_jobs/utils/list_runtimejob/ with job id as argument. It lists all RuntimeJob entries for the job id.

[psschwei]

couple of nits on the API:

• api/v1/runtime_jobs/utils/create_runtimejob/: the runtimejob in the last part is a bit redundant, so can we drop that?
• using api/v1/runtime_jobs/utils/create/ to list all jobs seems a little counter-intuitive... what about using a different, more explicit path (maybe something like .../list/ or .../jobs/)?

[akihikokuroda]

@psschwei Thanks for review. I'll update them to

api/v1/runtime_jobs/utils/add/
api/v1/runtime_jobs/utils/issued/

add: add runtime job id to the middleware job.
issued: return runtime job ids issued in the middleware job

[psschwei]

Thinking about this in the context of #1164 : would these APIs make sense as a subfunction of jobs, i.e. something like api/vi/jobs/<job_id>/runtime_jobs/issued/ ? If that's a long conversation (as we've got a few other API issues/PRs in the works), we could also split the APIs into a separate PR and merge the model creation here.

WDYT? I don't have strong opinions here, just know that changing an API once it's out there is not the most fun thing in the world 😄

[IceKhan13]

IsOwner might not work here because it is checking owner or author field of object. But RuntimeJob does not have that.

We can modify IsOwner permission class a little bit to act differently based on object type. Something like

# Instaed of this
class IsOwner(permissions.BasePermission):
    """
    Custom permission to only allow owners of an object to edit it.
    """

    def has_object_permission(self, request, view, obj):
        return obj.author == request.user
        
# do something like
class IsOwner(permissions.BasePermission):
    """
    Custom permission to only allow owners of an object to edit it.
    """

    def has_object_permission(self, request, view, obj):
        if isinstance(obj, RuntimeJob):
            return obj.job.author == request.user
        return obj.author == request.user

[IceKhan13]

I think we can use here standart django model viewset and it will give us CRUD on RuntimeJob object.

Or alternatevely, if we want to keep this view, we should use RuntimeJobSerializer to validate requests.

        serializer = RuntimeJobSerializer(data=request.data)
        serializer.is_valid(raise_exception=True) # or better handle exception and return response with explanation

[akihikokuroda]

@IceKhan13 I thought these APIs are convenient but both APIs can be replaces by one CRUD API call. I'll take it out.

[akihikokuroda]

@IceKhan13 On the second thought, the API getting the list of runtime jobs for the middleware job may may be useful when the RuntimeJob table gets huge. WDYT?

[IceKhan13]

Good point!

[IceKhan13]

My comment was about using default django api view. For RuntimeJob model, which gives all crud with validation out of the box.

https://www.django-rest-framework.org/api-guide/viewsets/#modelviewset

Basically

class RuntimeJobViewSet(viewsets.ModelViewSet):
    serializer_class = RuntimeJobSerializer
    permission_classes = [...]

    def get_queryset(self):
        return RuntimeJob.object.filter(job__author=self.request.user)
        
    ... # add here insert if needed

[IceKhan13]

But let's merge this PR and add API view in separate one.

[akihikokuroda]

I look out APIs. This PR basically has model change only.

[psschwei]

Was this left over from the API part that was removed?

[akihikokuroda]

Yes, I take out. Thanks!

[IceKhan13]

Let's merge this PR and add API view for RuntimeJob in separate PR

Thank you, Aki!