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

Change todo move API to reference previous uid #102795

Merged
merged 2 commits into from
Oct 26, 2023

Conversation

allenporter
Copy link
Contributor

@allenporter allenporter commented Oct 25, 2023

Proposed change

Change todo move API to reference previous uid so that the frontend can sort items without worrying about the ordering for complete vs needs-action items.

This is a partial revert to the original API in #100019 and #102627 with some additional simplifications, so it should be re-reviewed.

This is a breaking change for the todo api, but should be save since it has not been released yet.

This PR needs a frontend PR approved before merge: home-assistant/frontend#18410

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (todo) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of todo can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign todo Removes the current integration label and assignees on the pull request, add the integration domain after the command.

# Prepare items for moving
previous_uid: str | None = None
if dst_idx is not None:
previous_uid = uids[dst_idx]
Copy link
Member

Choose a reason for hiding this comment

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

Can we make the previous uid a test parameter instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We don't know it until it is created since uids are created on the fly. We could seed with a fixed database, or mock out uid creation deep in the library, though my thought is that might be too tight of a coupling with an internal detail. However ical does this for it's own tests so there are some util hooks for that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

(I was replying for ical though same techniques could be used across both)

Copy link
Member

Choose a reason for hiding this comment

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

Hmm ok. I guess it's ok like this then.

Copy link
Member

@MartinHjelmare MartinHjelmare left a comment

Choose a reason for hiding this comment

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

Looks good if we add a note about the meaning of previous uid and when it's None.

@MartinHjelmare MartinHjelmare added this to the 2023.11.0 milestone Oct 26, 2023
@MartinHjelmare
Copy link
Member

Can be merged when the frontend PR is approved.

@piitaya
Copy link
Member

piitaya commented Oct 26, 2023

@MartinHjelmare Frontend PR approved and merged.
Update frontend PR : #102857

@frenck frenck merged commit af9cae2 into home-assistant:dev Oct 26, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Oct 28, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants