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

Use Octue SDK without answer topics #57

Merged
merged 42 commits into from
Feb 6, 2024

Conversation

cortadocodes
Copy link
Member

@cortadocodes cortadocodes commented Nov 16, 2023

Contents (#57)

IMPORTANT: There are 2 breaking changes.

New features

  • Add question events mixin and use it in Question model
  • Add fields for getting various response types to question admin
  • Add status field to AbstractQuestion model and show status in question admin

Enhancements

  • 💥 BREAKING CHANGE: Remove unused fieldsets module
  • Format question logstreams more efficiently and readably in question admin
  • Only show datetimes of delivery acknowledgement and latest heartbeat
  • Add get_output_values and get_output_manifest methods to question model

Fixes

  • Update "type" to "kind" for octue events in a backwards-compatible way

Refactoring

  • Remove unused ReelMessage and websockets-related code
  • Remove question database storage mixins
  • Remove Question methods overriding identical methods in AbstractQuestion

Operations

  • Use reusable workflows

Dependencies

  • 💥 BREAKING CHANGE: Use octue>=0.52.0

Chores

  • Update pre-commit config
  • Remove DS_Store file

Other

  • Update copyright year in docs

Upgrade instructions

💥 Use `octue>=0.52.0`

Upgrade all Octue services in the network of services called by your instance of django-twined to run on octue>=0.52.0

💥 Remove unused `fieldsets` module

If you imported these for your question admin subclass, simply stop importing them and use the updated QuestionAdmin.

@cortadocodes cortadocodes self-assigned this Nov 16, 2023
@codecov-commenter
Copy link

codecov-commenter commented Nov 16, 2023

Codecov Report

Attention: 28 lines in your changes are missing coverage. Please review.

Comparison is base (878b3c6) 50.96% compared to head (06400eb) 50.79%.

Files Patch % Lines
django_twined/models/service_usage_events.py 43.75% 18 Missing ⚠️
django_twined/admin/admin.py 58.33% 10 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #57      +/-   ##
==========================================
- Coverage   50.96%   50.79%   -0.18%     
==========================================
  Files          43       43              
  Lines         832      886      +54     
==========================================
+ Hits          424      450      +26     
- Misses        408      436      +28     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@thclark thclark left a comment

Choose a reason for hiding this comment

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

This LGTM for experimentation purposes but let's release at the same time as we release octue.

pyproject.toml Outdated Show resolved Hide resolved
@cortadocodes
Copy link
Member Author

Questions for @thclark when we discuss this:

  • QuestionValuesDatabaseStorageMixin and QuestionManifestsDatabaseStorageMixin are marked as deprecated. Should we stop using them entirely (exa currently uses them) or should we continue for now?
  • How do I get data out of a ValuesField?
  • Do we need to implement an input_values method in the QuestionEventsMixin?

pyproject.toml Outdated Show resolved Hide resolved
@cortadocodes cortadocodes linked an issue Feb 6, 2024 that may be closed by this pull request
4 tasks
@cortadocodes cortadocodes linked an issue Feb 6, 2024 that may be closed by this pull request
@cortadocodes cortadocodes merged commit 1c1bdfc into main Feb 6, 2024
6 checks passed
@cortadocodes cortadocodes deleted the use-octue-without-answer-topics branch February 6, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants