Verification Request: homebridge-qbittorrent-plugin

[RauchenwaldC]

Plugin Name

homebridge-qbittorrent-plugin

Link To GitHub Repo

https://github.com/RauchenwaldC/homebridge-qbittorrent-plugin

Plugin Icon (Optional)

No response

The plugin does not offer the same nor less functionality than that of any existing verified plugin.

🟢 Yes

The plugin successfully installs and does not start unless it is configured.

🟢 Yes

The plugin does not require the user to run Homebridge in a TTY or with non-standard startup parameters, even for initial configuration.

🟢 Yes

The plugin does not contain any analytics or calls that enable you to track the user.

🟢 Yes

If the plugin needs to write files to disk (cache, keys, etc.), it stores them inside the Homebridge storage directory.

🟢 Yes

The plugin does not throw unhandled exceptions, the plugin must catch and log its own errors.

🟢 Yes

More Information

No response

[RauchenwaldC]

/check

[RauchenwaldC]

/check

[bwp91]

/check

[github-actions]

🔴 The following checks failed:

• GitHub Repo: should have issues enabled
• GitHub Repo: should contain releases

---

🟢 The following checks passed:

• Installation: successfully installed
• Package JSON: homepage exists
• Package JSON: bugs.url exists and seems a valid URL
• Package JSON: keywords exist and contain 'homebridge-plugin'
• Package JSON: 'preinstall' in scripts is not present
• Package JSON: 'install' in scripts is not present
• Package JSON: 'postinstall' in scripts is not present
• Package JSON: engines.node property is compatible with Node 18
• Package JSON: engines.node property is compatible with Node 20
• Package JSON: engines.homebridge property is compatible with Homebridge 1.8.4
• Package JSON: initializer function found
• GitHub Repo: repository is public
• GitHub Repo: repository is not archived
• NPM Package: has not been deprecated
• Config Schema JSON: exists and is valid JSON
• Config Schema JSON: contains a valid pluginAlias
• Config Schema JSON: the pluginType is set to 'platform'
• Config Schema JSON: contains a name schema property
• Dependencies: homebridge was not installed as a dependency
• Dependencies: hap-nodejs was not installed as a dependency

---

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

[RauchenwaldC]

@bwp91 Sorry to bother you. The repository already had Issues enabled and contains releases. What am I missing?

[bwp91]

probably because the github urls in your package json file are not standard

https://github.com/RauchenwaldC/homebridge-qbittorrent-plugin/blob/4cc86a4340de6ef489073b7aea27908d35c984f9/package.json#L13

[RauchenwaldC]

/check

[github-actions]

🔴 The following checks failed:

• GitHub Repo: should have issues enabled
• GitHub Repo: should contain releases

---

🟢 The following checks passed:

• Installation: successfully installed
• Package JSON: homepage exists
• Package JSON: bugs.url exists and seems a valid URL
• Package JSON: keywords exist and contain 'homebridge-plugin'
• Package JSON: 'preinstall' in scripts is not present
• Package JSON: 'install' in scripts is not present
• Package JSON: 'postinstall' in scripts is not present
• Package JSON: engines.node property is compatible with Node 18
• Package JSON: engines.node property is compatible with Node 20
• Package JSON: engines.homebridge property is compatible with Homebridge 1.8.4
• Package JSON: initializer function found
• GitHub Repo: repository is public
• GitHub Repo: repository is not archived
• NPM Package: has not been deprecated
• Config Schema JSON: exists and is valid JSON
• Config Schema JSON: contains a valid pluginAlias
• Config Schema JSON: the pluginType is set to 'platform'
• Config Schema JSON: contains a name schema property
• Dependencies: homebridge was not installed as a dependency
• Dependencies: hap-nodejs was not installed as a dependency

---

⚠️ Please action these failures and then comment /check to run the checks again. Let us know if you need any help.

If updating your package.json and config.schema.json files, don't forget to publish a new version to NPM.

[RauchenwaldC]

/check

[github-actions]

🟢 The following checks passed:

• Installation: successfully installed
• Package JSON: homepage exists
• Package JSON: bugs.url exists and seems a valid URL
• Package JSON: keywords exist and contain 'homebridge-plugin'
• Package JSON: 'preinstall' in scripts is not present
• Package JSON: 'install' in scripts is not present
• Package JSON: 'postinstall' in scripts is not present
• Package JSON: engines.node property is compatible with Node 18
• Package JSON: engines.node property is compatible with Node 20
• Package JSON: engines.homebridge property is compatible with Homebridge 1.8.4
• Package JSON: initializer function found
• GitHub Repo: repository is public
• GitHub Repo: repository is not archived
• GitHub Repo: issues are enabled
• GitHub Repo: contains releases
• NPM Package: has not been deprecated
• Config Schema JSON: exists and is valid JSON
• Config Schema JSON: contains a valid pluginAlias
• Config Schema JSON: the pluginType is set to 'platform'
• Config Schema JSON: contains a name schema property
• Dependencies: homebridge was not installed as a dependency
• Dependencies: hap-nodejs was not installed as a dependency

---

🎉 All checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

[bwp91]

/check

[github-actions]

🟢 The following checks passed:

• Installation: successfully installed
• Package JSON: homepage exists
• Package JSON: bugs.url exists and seems a valid URL
• Package JSON: keywords exist and contain 'homebridge-plugin'
• Package JSON: 'preinstall' in scripts is not present
• Package JSON: 'install' in scripts is not present
• Package JSON: 'postinstall' in scripts is not present
• Package JSON: engines.node property is compatible with Node 18
• Package JSON: engines.node property is compatible with Node 20
• Package JSON: engines.node property is compatible with Node 22
• Package JSON: engines.homebridge property is compatible with Homebridge 1.8.5
• Package JSON: initializer function found
• GitHub Repo: repository is public
• GitHub Repo: repository is not archived
• GitHub Repo: issues are enabled
• GitHub Repo: contains releases
• NPM Package: has not been deprecated
• Config Schema JSON: exists and is valid JSON
• Config Schema JSON: contains a valid pluginAlias
• Config Schema JSON: the pluginType is set to 'platform'
• Config Schema JSON: contains a name schema property
• Dependencies: homebridge was not installed as a dependency
• Dependencies: hap-nodejs was not installed as a dependency

---

🎉 All checks passed successfully, nice work! Your plugin and/or icon will now be manually reviewed by the Homebridge team.

These checks were run against v1.1.2 of the plugin.

[bwp91]

With a config of:

        {
            "name": "qBittorrent Platform",
            "platform": "qBittorrentHomebridgePlugin"
        }

and when I try to control the switch, it shows an error in the log

[29/12/2024, 14:39:11] [homebridge-qbittorrent-plugin] This plugin threw an error from the characteristic 'On': Unhandled error thrown inside read handler for characteristic: Cannot read properties of undefined (reading 'replace'). See https://homebridge.io/w/JtMGR for more info.
[29/12/2024, 14:39:11] [homebridge-qbittorrent-plugin] TypeError: Cannot read properties of undefined (reading 'replace')
    at qBittorrentPlatformAccessory.getAdvancedRateLimits (file:///var/lib/homebridge/node_modules/homebridge-qbittorrent-plugin/src/platformAccessory.ts:47:34)
    at On.handleGetRequest (/var/lib/homebridge/node_modules/homebridge/node_modules/hap-nodejs/src/lib/Characteristic.ts:2213:32)
    at On.toHAP (/var/lib/homebridge/node_modules/homebridge/node_modules/hap-nodejs/src/lib/Characteristic.ts:2850:22)
    at /var/lib/homebridge/node_modules/homebridge/node_modules/hap-nodejs/src/lib/Service.ts:876:24
    at new Promise (<anonymous>)
    at Switch.toHAP (/var/lib/homebridge/node_modules/homebridge/node_modules/hap-nodejs/src/lib/Service.ts:824:12)
    at /var/lib/homebridge/node_modules/homebridge/node_modules/hap-nodejs/src/lib/Accessory.ts:1044:72
    at Array.map (<anonymous>)
    at Accessory.toHAP (/var/lib/homebridge/node_modules/homebridge/node_modules/hap-nodejs/src/lib/Accessory.ts:1044:49)
    at /var/lib/homebridge/node_modules/homebridge/node_modules/hap-nodejs/src/lib/Accessory.ts:1052:39

Although it isn't crashing the process (good), I'm assuming this is because there is a 'required' config value that I am missing. Perhaps when the plugin loads, it could check for the required config values, and if they don't exist, then log an error and return; before the didFinishLaunching here:

https://github.com/RauchenwaldC/homebridge-qbittorrent-plugin/blob/30993c1689a354cc07a83503b1b07c30bcbfad7f/src/platform.ts#L22

Then at least the 'Advanced Rate Limits' switch will not show, until the user has configured the plugin correctly. I appreciate that the URL field is marked as required in the config, but this still does not stop the user from being able to save with an empty value there.