Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run refactorization #1286

Merged
merged 22 commits into from
Apr 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions client/quantum_serverless/core/job.py
Original file line number Diff line number Diff line change
Expand Up @@ -426,12 +426,12 @@ def run( # pylint: disable=too-many-locals
"entrypoint": program.entrypoint,
"arguments": json.dumps(arguments or {}, cls=QiskitObjectsEncoder),
"dependencies": json.dumps(program.dependencies or []),
"env_var": json.dumps(program.env_vars or {}),
} # type: Dict[str, Any]
"env_vars": json.dumps(program.env_vars or {}),
}
if config:
data["config"] = asdict(config)
data["config"] = json.dumps(asdict(config))
else:
data["config"] = {}
data["config"] = "{}"

response_data = safe_json_request(
request=lambda: requests.post(
Expand Down
42 changes: 0 additions & 42 deletions gateway/api/exceptions.py

This file was deleted.

75 changes: 72 additions & 3 deletions gateway/api/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def update(self, instance, validated_data):
)
instance.entrypoint = validated_data.get("entrypoint")
instance.dependencies = validated_data.get("dependencies", "[]")
instance.env_vars = validated_data.get("env_vars", "{}")
instance.env_vars = validated_data.get("env_vars", {})
instance.artifact = validated_data.get("artifact")
instance.author = validated_data.get("author")
instance.save()
Expand Down Expand Up @@ -138,9 +138,9 @@ def create(self, validated_data):
pass


class RunExistingJobSerializer(serializers.ModelSerializer):
class RunJobSerializer(serializers.ModelSerializer):
"""
Job serializer for the /run_existing end-point
Job serializer for the /run and /run_existing end-point
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

long-term thought: would it make sense to refactor the API to just use a single /run endpoint and distinguish within the call whether the program/function/pattern/job/building_block/element/quantum_magic has already been uploaded or not?

Copy link
Member Author

@Tansito Tansito Apr 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely I think it's something that we can propose. I had in mind to continue the improvements in the gateway from a code organization point of view: #1286 (comment)

I considered too that we could refactor /run end-point to /upload + /run_existing in the client or something like that. Feel free to open an issue or a discussion because I think it deserves the times the refactorization.

"""

class Meta:
Expand Down Expand Up @@ -187,3 +187,72 @@ class RuntimeJobSerializer(serializers.ModelSerializer):

class Meta:
model = RuntimeJob


class RunProgramSerializer(serializers.Serializer):
"""
Program serializer for the /run end-point
"""

title = serializers.CharField(max_length=255, allow_blank=False)
entrypoint = serializers.CharField(max_length=255)
artifact = serializers.FileField(allow_empty_file=False, use_url=False)
dependencies = serializers.CharField(allow_blank=False)
arguments = serializers.CharField(allow_blank=False)
env_vars = serializers.CharField(allow_blank=False)
config = serializers.CharField(allow_blank=False)
Tansito marked this conversation as resolved.
Show resolved Hide resolved

def to_representation(self, instance):
"""
Transforms string `config` to JSON
"""
representation = super().to_representation(instance)
representation["config"] = json.loads(representation["config"])
return representation

def retrieve_one_by_title(self, title, author):
"""
This method returns a Program entry if it finds an entry searching by the title, if not None
"""
return (
Program.objects.filter(title=title, author=author)
.order_by("-created")
.first()
)

def create(self, validated_data):
pass

def update(self, instance, validated_data):
pass


class RunProgramModelSerializer(serializers.ModelSerializer):
Tansito marked this conversation as resolved.
Show resolved Hide resolved
"""
Program model serializer for the /run end-point
"""

arguments = serializers.CharField(read_only=True)
config = serializers.CharField(read_only=True)
Tansito marked this conversation as resolved.
Show resolved Hide resolved

class Meta:
model = Program

def create(self, validated_data):
title = validated_data.get("title")
logger.info("Creating program [%s] with RunProgramSerializer", title)
env_vars = validated_data.get("env_vars")
if env_vars:
encrypted_env_vars = encrypt_env_vars(json.loads(env_vars))
validated_data["env_vars"] = json.dumps(encrypted_env_vars)
return Program.objects.create(**validated_data)

def update(self, instance, validated_data):
logger.info("Updating program [%s] with RunProgramSerializer", instance.title)
instance.entrypoint = validated_data.get("entrypoint")
instance.dependencies = validated_data.get("dependencies", "[]")
instance.env_vars = validated_data.get("env_vars", {})
instance.artifact = validated_data.get("artifact")
instance.author = validated_data.get("author")
instance.save()
return instance
199 changes: 0 additions & 199 deletions gateway/api/services.py

This file was deleted.

27 changes: 24 additions & 3 deletions gateway/api/v1/serializers.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ class Meta(serializers.JobConfigSerializer.Meta):
]


class RunExistingJobSerializer(serializers.RunExistingJobSerializer):
class RunJobSerializer(serializers.RunJobSerializer):
"""
RunExistingJobSerializer is used by the /run_existing end-point
RunJobSerializer is used by the /run and /run_existing end-points
"""

class Meta(serializers.RunExistingJobSerializer.Meta):
class Meta(serializers.RunJobSerializer.Meta):
fields = ["id", "result", "status", "program", "created", "arguments"]


Expand All @@ -84,3 +84,24 @@ class RuntimeJobSerializer(serializers.RuntimeJobSerializer):

class Meta(serializers.RuntimeJobSerializer.Meta):
fields = ["job", "runtime_job"]


class RunProgramSerializer(serializers.RunProgramSerializer):
"""
RunProgram serializer is used in /run end-point
"""


class RunProgramModelSerializer(serializers.RunProgramModelSerializer):
"""
RunProgram model serializer is used in /run end-point
"""

class Meta(serializers.RunProgramModelSerializer.Meta):
fields = [
"title",
"entrypoint",
"artifact",
"dependencies",
"env_vars",
]
Loading
Loading