Add orchestra api for todo templates and starting order #736

adbharadwaj · 2021-01-20T01:04:07Z

Added three orchestra API:

Get todo templates
- Returns list of todo templates
Create todos from a template
- Input is project id, template slug, and step slug
- Returns a dictionary with keys success=True and todos=List of newly created todos
Add step id field to the list of steps returned with get project information api

coveralls · 2021-01-20T01:20:57Z

Coverage increased (+0.07%) to 94.433% when pulling 8259c2e on todo-template-api into 90f7c01 on main.

marcua · 2021-01-21T01:05:31Z

orchestra/project_api/views.py

+              permissions=(IsSignedUser,),
+              logger=logger,
+              auths=(OrchestraProjectAPIAuthentication,))
+def todo_sections_starting_order(request):


@jumasheff is doing the code review, so i'll just focus on this one endpoint to make sure I understand its purpose.

I can't think of an experience in Orchestra or the B12 product that requires this order from Orchestra, as the product currently decides on the fixed section order on its end. Since Orchestra doesn't model sections deeply (maybe it should---right now they are just strings), it seems like the metadata for the section order doesn't have a great home in Orchestra without more data modelling.

Because of the lack of model, the implementation here orders sections by count, which is different from the behavior in the product. I'm open to ideas, but I can imagine two worlds

Make it so sections are just strings in Orchestra. The caller (e.g., B12 product) can determine their display order.

Push section metadata like section order into Orchestra's data model for to-do lists, and as a result, add that information to the existing to-do endpoints.

Got rid of the API.

jumasheff · 2021-01-21T06:44:03Z

orchestra/tests/test_todos.py

@@ -581,6 +587,7 @@ def test_update_todos_from_todolist_template_success(self):
                       project=self.project.id,
                       step=self.step.slug),
        ]
+        print(expected_todos)


Remove print

jumasheff · 2021-01-21T07:29:11Z

orchestra/project_api/views.py

+        }
+
+
+@api_endpoint(methods=['POST'],


Why POST, and not GET?

Got rid of the API itself.

…odo-template-api

* Added Task Created column * Updated to comments * Added compiled js * Added datetime checking + fixes

Co-authored-by: Aditya Bharadwaj <aditya@b12.io>

* filter staffing requests from completed projects * exclude aborted projects Co-authored-by: Aditya Bharadwaj <aditya@b12.io>

(cherry picked from commit a9d03e6) Co-authored-by: Adam Marcus <marcua@marcua.net>

* pin py-moneyed dependency * add hourly_rate_currency migration Co-authored-by: Aditya Bharadwaj <aditya@b12.io>

…odo-template-api

jumasheff · 2021-01-25T05:17:54Z

orchestra/project_api/views.py

+    authentication_classes = (OrchestraProjectAPIAuthentication,)
+
+    serializer_class = TodoListTemplateSerializer
+    queryset = TodoListTemplate.objects.all()


queryset = TodoListTemplate.objects.filter(is_deleted=False)

I don't think we will need this because we are inheriting from BaseModel which inherits from BaseModelManager.

orchestra/orchestra/models/core/models.py

Line 597 in e2c9930

class TodoListTemplate(TodoListTemplateMixin, BaseModel):

orchestra/orchestra/utils/models.py

Lines 53 to 64 in e2c9930

class BaseModel(DeleteMixin, models.Model):

"""

Abstract base class models which defines created_at and is_deleted fields.

Attributes:

created_at (datetime.datetime):

Datetime at which the model is created.

is_deleted (boolean):

If value is True, mdoel is deleted. Default is False.

"""

objects = BaseModelManager()

unsafe_objects = models.Manager()

orchestra/orchestra/utils/models.py

Lines 42 to 50 in e2c9930

class BaseModelManager(models.Manager):

"""

Model manager intended to be used with models with an `is_deleted` field.

Overrides the initial QuerySet to filter for objects where `is_deleted`

is false.

"""

def get_queryset(self):

return super().get_queryset().filter(is_deleted=False)

BaseModelManager sets the default query to is_deleted=False

Just to be sure, I confirmed by deleting a todolist template and made sure that we don't need is_deleted=False

Wow! Ignore my suggestion. A!

Aditya Bharadwaj added 4 commits January 15, 2021 20:16

get todo templates

51f0966

add todos from template

f729ee5

Implement api to get starting order

2bd39de

fix lint errors

f313aef

Aditya Bharadwaj added 3 commits January 20, 2021 21:49

allow passing additional data

3c30eb8

Added tests for error cases

7fae743

set todo status as declined if skipped

9d0757f

marcua reviewed Jan 21, 2021

View reviewed changes

Aditya Bharadwaj added 2 commits January 21, 2021 01:26

Test status field in todo

f1ea5a6

fix lint

ed0bed0

jumasheff reviewed Jan 21, 2021

View reviewed changes

Aditya Bharadwaj and others added 18 commits January 21, 2021 14:53

remove print

d8e6d9a

fix tests

171e564

get todo templates

f986354

add todos from template

4a6add3

Implement api to get starting order

c80af31

fix lint errors

687a46f

allow passing additional data

88291b3

Added tests for error cases

0a4b6a7

set todo status as declined if skipped

88a3585

Test status field in todo

c6e5d01

fix lint

acd0cb8

remove print

5f502da

fix tests

6fe2abc

remove starting order api

5ff6c51

Merge branch 'todo-template-api' of github.com:b12io/orchestra into t…

4d19b99

…odo-template-api

Version bump.

f267d8f

Added Task Created column (#473)

445ca8f

* Added Task Created column * Updated to comments * Added compiled js * Added datetime checking + fixes

Assignment lookup bugfix (#475)

0dbf521

adbharadwaj and others added 27 commits January 22, 2021 18:28

use pip version 20.2.4 for circleci (#716)

525df9d

Co-authored-by: Aditya Bharadwaj <aditya@b12.io>

Use linky instead of linkify (#724)

799e073

Co-authored-by: Aditya Bharadwaj <aditya@b12.io>

Version bump.

5c1db20

Filter staffing requests from completed projects (#726)

1a99292

* filter staffing requests from completed projects * exclude aborted projects Co-authored-by: Aditya Bharadwaj <aditya@b12.io>

Version bump.

7811df6

Remove unused Kronos dependency (#734)

b6ff34c

(cherry picked from commit a9d03e6) Co-authored-by: Adam Marcus <marcua@marcua.net>

Version bump.

2a6fd98

get todo templates

91f596f

add todos from template

cfcc455

Implement api to get starting order

225cdd4

fix lint errors

9db42bd

allow passing additional data

32ba349

Added tests for error cases

5081cce

set todo status as declined if skipped

121a8ac

Test status field in todo

254dbd2

fix lint

9866146

remove print

85c0723

fix tests

fed317e

Pin py-moneyed dependency (#737)

3b86747

* pin py-moneyed dependency * add hourly_rate_currency migration Co-authored-by: Aditya Bharadwaj <aditya@b12.io>

Version bump.

fd974ab

fix rebase conflicts

9a03584

fix rebase conflicts

8c6c565

fix rebase conflicts

23f886f

remove print

40bff9a

Fix rebase conflicts

e1d7d97

Merge branch 'todo-template-api' of github.com:b12io/orchestra into t…

234bed9

…odo-template-api

return step id with project information api

8259c2e

jumasheff reviewed Jan 25, 2021

View reviewed changes

jumasheff approved these changes Jan 25, 2021

View reviewed changes

adbharadwaj merged commit 29e5ffe into main Jan 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add orchestra api for todo templates and starting order #736

Add orchestra api for todo templates and starting order #736

adbharadwaj commented Jan 20, 2021 •

edited

coveralls commented Jan 20, 2021 •

edited

marcua Jan 21, 2021

adbharadwaj Jan 22, 2021

jumasheff Jan 21, 2021

adbharadwaj Jan 22, 2021

jumasheff Jan 21, 2021

adbharadwaj Jan 22, 2021

jumasheff Jan 25, 2021

adbharadwaj Jan 25, 2021 •

edited

adbharadwaj Jan 25, 2021 •

edited

jumasheff Jan 25, 2021

	class BaseModel(DeleteMixin, models.Model):
	"""
	Abstract base class models which defines created_at and is_deleted fields.

	Attributes:
	created_at (datetime.datetime):
	Datetime at which the model is created.
	is_deleted (boolean):
	If value is True, mdoel is deleted. Default is False.
	"""
	objects = BaseModelManager()
	unsafe_objects = models.Manager()

	class BaseModelManager(models.Manager):
	"""
	Model manager intended to be used with models with an `is_deleted` field.
	Overrides the initial QuerySet to filter for objects where `is_deleted`
	is false.
	"""

	def get_queryset(self):
	return super().get_queryset().filter(is_deleted=False)

		}


		@api_endpoint(methods=['POST'],

Add orchestra api for todo templates and starting order #736

Add orchestra api for todo templates and starting order #736

Conversation

adbharadwaj commented Jan 20, 2021 • edited

coveralls commented Jan 20, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adbharadwaj Jan 25, 2021 • edited

Choose a reason for hiding this comment

adbharadwaj Jan 25, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adbharadwaj commented Jan 20, 2021 •

edited

coveralls commented Jan 20, 2021 •

edited

adbharadwaj Jan 25, 2021 •

edited

adbharadwaj Jan 25, 2021 •

edited