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

Reach gold level in Minecraft Server #102462

Merged
merged 1 commit into from Oct 22, 2023
Merged

Conversation

elmurato
Copy link
Contributor

@elmurato elmurato commented Oct 21, 2023

Proposed change

SSIA

No score

Silver 🥈

  • ✅ Satisfying all No score level requirements.
  • ✅ Connection/configuration is handled via a component.
  • ✅ Set an appropriate SCAN_INTERVAL (if a polling integration) ➡️ 1 minute
  • ➖ Raise PlatformNotReady if unable to connect during platform setup (if appropriate) ➡️ ConfigEntryNotReady supported via DataUpdateCoordinator instead, all data are fetched centrally
  • ➖ Handles expiration of auth credentials. Refresh if possible or print correct error and fail setup. If based on a config entry, should trigger a new config entry flow to re-authorize. (docs) ➡️ No authentication required
  • ✅ Handles internet unavailable. Log a warning once when unavailable, log once when reconnected. ➡️ DataUpdateCoordinator
  • ✅ Handles device/service unavailable. Log a warning once when unavailable, log once when reconnected. ➡️ DataUpdateCoordinator
  • ➖ Operations like service calls and entity methods (e.g. Set HVAC Mode) have proper exception handling. Raise ValueError on invalid user input and raise HomeAssistantError for other failures such as a problem communicating with a device. ➡️ No services are supported
  • ✅ Set available property to False if appropriate (docs)
  • ✅ Entities have unique ID (if available) (docs)

Gold 🥇

  • ✅ Satisfying all Silver level requirements.
  • Configurable via config entries.
    • ➖ Don't allow configuring already configured device/service (example: no 2 entries for same hub) ➡️ Not really possible as there is no unique information available from the library/server during config flow. Only possibility would be to check if the entered server address is already used in one of the existing config entries.
    • ➖ Discoverable (if available) ➡️ Didn't find way for auto discovery.
    • ➖ Set unique ID in config flow (if available) ➡️ No unique information available from library/server
    • ✅ Raise ConfigEntryNotReady if unable to connect during entry setup (if appropriate) ➡️ DataUpdateCoordinator
  • ✅ Entities have device info (if available) (docs)
  • Tests
    • ✅ Full test coverage for the config flow
    • ✅ Above average test coverage for all integration modules ➡️ Test coverage is 100%
    • ✅ Tests for fetching data from the integration and controlling it (docs)
  • ✅ Has a code owner (docs)
  • ✅ Entities only subscribe to updates inside async_added_to_hass and unsubscribe inside async_will_remove_from_hass (docs) ➡️ DataUpdateCoordinator
  • ✅ Entities have correct device classes where appropriate (docs)
  • ✅ Supports entities being disabled and leverages Entity.entity_registry_enabled_default to disable less popular entities (docs)
  • ➖ If the device/service API can remove entities, the integration should make sure to clean up the entity and device registry. ➡️ Entities cannot be removed via device/service API
  • ✅ When communicating with a device or service, the integration implements the diagnostics platform which redacts sensitive information.

Platinum 🏆

  • ✅ Satisfying all Gold level requirements.
  • ✅ Set appropriate PARALLEL_UPDATES constant (docs) ➡️ Default value is probably fine for this integration
  • ✅ Support config entry unloading (called when config entry is removed)
  • ❌ Integration + dependency are async (docs)
    Uses aiohttp or httpx and allows passing in websession (if making HTTP requests) ➡️ lookup API of the library for Bedrock Edition servers is not async
  • Handles expired credentials (if appropriate) ➡️ No authentication/credentials required

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:

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @elmurato 👍

../Frenck

@frenck frenck merged commit 8bfd418 into home-assistant:dev Oct 22, 2023
23 checks passed
@elmurato elmurato deleted the mcserver-gold branch October 22, 2023 14:18
@github-actions github-actions bot locked and limited conversation to collaborators Oct 23, 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.

None yet

2 participants