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

feat: Provide add_or_edit root-only endpoint for importers #1380

Merged
merged 6 commits into from
Jan 23, 2025
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
42 changes: 42 additions & 0 deletions src/viur/core/prototypes/skelmodule.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import yaml
import logging
from viur.core import Module, db, current
from viur.core.decorators import *
from viur.core.config import conf
from viur.core.skeleton import skeletonByKind, Skeleton, SkeletonInstance
import typing as t
Expand Down Expand Up @@ -147,3 +148,44 @@ def _apply_default_order(self, query: db.Query):
query.order(default_order)
else:
query.order(*default_order)

@force_ssl
@force_post
@exposed
@skey
@access("root")
def add_or_edit(self, key: db.Key | int | str, **kwargs) -> t.Any:
"""
This function is intended to be used by importers.
Only "root"-users are allowed to use it.
"""
db_key = db.keyHelper(key, targetKind=self.kindName, adjust_kind=self.kindName)
is_add = not bool(db.Get(db_key))

if is_add:
skel = self.addSkel()
else:
skel = self.editSkel()

skel["key"] = db_key

if (
not kwargs # no data supplied
or not skel.fromClient(kwargs) # failure on reading into the bones
):
# render the skeleton in the version it could as far as it could be read.
return self.render.render("add_or_edit", skel)

if is_add:
self.onAdd(skel)
else:
self.onEdit(skel)

skel.write()

if is_add:
self.onAdded(skel)
return self.render.addSuccess(skel)

self.onEdited(skel)
return self.render.editSuccess(skel)
46 changes: 46 additions & 0 deletions src/viur/core/prototypes/tree.py
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,52 @@ def add(self, skelType: SkelType, node: db.Key | int | str, *args, **kwargs) ->

return self.render.addSuccess(skel)

@force_ssl
@force_post
@exposed
@skey
@access("root")
def add_or_edit(self, skelType: SkelType, key: db.Key | int | str, **kwargs) -> t.Any:
"""
This function is intended to be used by importers.
Only "root"-users are allowed to use it.
"""
if not (skelType := self._checkSkelType(skelType)):
raise errors.NotAcceptable("Invalid skelType provided.")

kind_name = self.nodeSkelCls.kindName if skelType == "node" else self.leafSkelCls.kindName

db_key = db.keyHelper(key, targetKind=kind_name, adjust_kind=kind_name)
is_add = not bool(db.Get(db_key))

if is_add:
skel = self.addSkel(skelType)
else:
skel = self.editSkel(skelType)

skel["key"] = db_key

if (
not kwargs # no data supplied
or not skel.fromClient(kwargs) # failure on reading into the bones
):
# render the skeleton in the version it could as far as it could be read.
return self.render.render("add_or_edit", skel)

if is_add:
self.onAdd(skelType, skel)
else:
self.onEdit(skelType, skel)

skel.write()

if is_add:
self.onAdded(skelType, skel)
return self.render.addSuccess(skel)

self.onEdited(skelType, skel)
return self.render.editSuccess(skel)

@exposed
@force_ssl
@skey(allow_empty=True)
Expand Down
Loading