Documentation for custom actions

[tokejepsen]

I could only find a mention of custom actions in the documentation.

What are custom actions and how about they meant to be used?

[frankrousseau]

This is definitely missing. Custom actions allow people to send a selection to an external web service. It creates a POST request and send it to the endpoint listed in custom action. The body of the POST request contains the user information and the ids of the selected tasks. This way you can customize a little bit the application

Information sent are listed here:

https://github.com/cgwire/kitsu/blob/master/src/components/ActionTopbar.vue#L127-L133

[frankrousseau]

• personid
• personemail
• projectid
• currentpath (current url path)
• currentserver (host of the current server)
• selectedTaskIds
• entity_type (asset or shot)

[tokejepsen]

I tried running a server to listen for requests, and have configured a custom action in Kitsu.
Using the docker image with Docker Toolbox and I can't seem to get it to work. It returns 405 Not Allowed on http://127.0.0.1:8080 and http://192.168.99.100:8080

[tokejepsen]

Forgot to say that I using this commands for Docker:

docker run --name avalon-tracker -d --rm \
    -v avalon-tracker:/var/lib/postgresql \
    -v avalon-tracker:/opt/zou/zou/thumbnails \
    -p 80:80 \
    -p 8080:8080 \
    avalon/tracker

[frankrousseau]

The request sent is a POST request I think. Is it what is expected on your service side?

It may be due too to the fact you don't use the same domain for both applications.

[tokejepsen]

Is it what is expected on your service side?

I'm pretty sure it is.

It may be due too to the fact you don't use the same domain for both applications.

I'm a complete novice on web development. I'm guessing you mean its because I'm not listening on a proper web address like http://example.com:8080?

[frankrousseau]

Web browsers don't like when things from a webdomain are targeting another domain. They consider it as an attack. So it's possible they prevent you to use a post request to your IP if it doesn't match the IP of you kitsu installation.

[flablog]

Hi there,
it might help, but this is what I usually catch on my custom actions, using a Tornado web server :

class ActionHandler(tornado.web.RequestHandler):
    def get(self):
        self.write('action not available without context')
    def post(self):
        selection_raw = self.get_argument('selection')
        selection = selection_raw.split(',')
        currentpath = self.get_argument('currentpath')
        currentserver = self.get_argument('currentserver')
        entity_type = self.get_argument('entity_type')
        personemail = self.get_argument('personemail')
        personid = self.get_argument('personid')
        projectid = self.get_argument('projectid')

In my case, this service is running on port 8889, but I don't care as Nginx is doing the rooting from a subdomain on port 80. But I can call this with the ip and port directly without problem.

[tokejepsen]

Thanks for that @flablog

How are you running Kitsu? Through Docker?

I tried your tornado snippet, but still no luck. I don't think its the server, but how data is coming out of Docker.

[flablog]

I'm not using a docker instance. So it might be related ? I've not tried it. I'm using the pip install as discribed in the documentation, on a virtual machine. No issue on having the custom action on another server, through a subdomain or using an IP directly. Then in production, the tornado instance with the custom tools is on the same VM as Kitsu Le lun. 9 juil. 2018 à 12:02, Toke Jepsen <notifications@github.com> a écrit :

…

Thanks for that @flablog <https://github.com/flablog> How are you running Kitsu? Through Docker? I tried your tornado snippet, but still no luck. I don't think its the server, but how data is coming out of Docker. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#97 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA1HM4_kCZMUUKQFBz4efBBB4f-qN-h_ks5uEyoogaJpZM4U8wRy> .

[tokejepsen]

Sorry this took me so long, but I have finally tested it with a bottle server and it work with Docker!

[tokejepsen]

For anyone struggling with this, here's a breakdown.

Requirements:

• Python (any version should work)
• A running instance of Kitsu (Using Docker might be easiest; https://github.com/cgwire/cgwire)

Download the two python scripts, and run python {path to server.py}.

In Kitsu create a custom action with the url: http://localhost:90. Select any task and run the custom action.
This should print the post request in the server console, and it'll look something similar to this:

{'personid': 'b01bae1e-f829-458a-a1eb-131bb66628cc', 'personemail': 'admin@example.com', 'projectid': 'fa4d7f04-b8e0-4518-8dbc-2f24997ca76e', 'currentpath': '/productions/fa4d7f04-b8e0-4518-8dbc-2f24997ca76e/assets', 'currentserver': 'localhost', 'selection': '95c171e1-dfff-498f-93e3-548a739e3202', 'entitytype': 'asset'}