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

Add waterkotte-easycon to latest #3396

Merged
merged 1 commit into from Apr 12, 2024
Merged

Add waterkotte-easycon to latest #3396

merged 1 commit into from Apr 12, 2024

Conversation

theknut
Copy link
Contributor

@theknut theknut commented Mar 11, 2024

No description provided.

@github-actions github-actions bot added auto-checked This PR was automatically checked for obvious criterias must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels Mar 11, 2024
@mcm1957 mcm1957 changed the title feat: add waterkotte-easycon to latest Add waterkotte-easycon to latest Mar 12, 2024
@mcm1957 mcm1957 added the (RE-)REVIEW pending (mcm1957) Changes requested by review have been applied, re-review could be done. label Mar 12, 2024
@github-actions github-actions bot deleted a comment from mcm1957 Mar 12, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Mar 12, 2024

Thanks for spending your time and providing a new adapter for ioBroker.

Your adapter will get a manual review as soon as possible. Please stand by - this might last one or two weeks. Feel free to continue your work and create new releases. You do NOT need to close or update this PR in case of new releases.

You will find the results of the review and evntually issues / suggestings as a communt to this PR. So please keep this PR watched.

If you have any urgent questions feel free to ask.

mcm1957

reminder 26.3.2024

@mcm1957
Copy link
Collaborator

mcm1957 commented Mar 16, 2024

First of all - THANK YOU for the time and effort you spend to maintain this adapter.

I would like to give some feedback based on my personal oppinion. @Apollon77 might have additional suggestions or even a different oppinion to one or the other statement. Please feel free to contact him if you cannot follow my suggestions or want to discuss some special aspects.

  • unused onStateChange handler

    You configred an onStateChange handler but it looks like this handler does not do any important tasks. Please remove the handler if the adapter does not react on state changes.

  • onStateChange handler ignores ack flag (NOT BLOCKING - information for future use only)

    The adapter must honor the ack flag when processing onStateChange events. Whenever the onStateChange handler is called for an own state (a state owned by the processing instance of the adapter) it must ignore this event if the ack flags is set. Only stateChanges with ack==false are allowed to be processed.

    When processing foreign states which are output of another adapter processing must only occure if the ack flag is true.

  • Is there any reason to not use i18n translation environment?

    I suggest to evaluate to use i18n translation environment and the iobroker/adapter-dev environment (https://github.com/ioBroker/adapter-dev#iobroker-adapter-dev). You could easyly add new strings to the english json and run npm run translate afterward. When using i18n environment activating iobrokers weblate translation system (see https://github.com/ioBrokerTranslator/doc) is trivial.

    Hardcoding text inside jsonConfig blocks usage of weblate transaltion system.

    NOTE: This is a suggestion only and nozt blocking.

  • check and limit configurable timeouts / intervals

    Node setTimeout/setInterval routines have a maximum allowed value of 2,147,483,647 ms. Using delays larger than 2,147,483,647 ms (about 24.8 days) result in the timeout being executed immediately. So all (user configurable) values passed to setTimeout / setInterval should be checked in code and limited. Checking/limiting in code is required as config data could be changed directly or by some other adapter too, so limiting at ui level might not be sufficient.

    I suggest to change the paramater at ui to minutes or seconds. Users would not expect a ms parameter here.

    And in any case limit the interval ta UI and inside code (!) to a reasonable value. Polling too fast could result in starting a new polling cycle before the previous cycle has finished. This could result in a crash of the complet ioBroker installation due to resource problems. Please ensure that pollingIntervall cannot by smaller than the longest prosessing time of a poll loop or replace setInterval by a setTimeout started at the end of a poll. This would be the most stable solution anyway.

  • Add timeout to axios calls

    All axios calls should have a timeout set. The default value for axios timeout is 0 which results in no timeout. So an unresponsive remote system could lead to an hanging adapter. Either set an appropiate timeout per axios call or set a default timeout globally for the axios instance.

Thanks for reading and evaluating this suggestions.
McM1957

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

reminder 25.3.2024

@mcm1957 mcm1957 added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review and removed (RE-)REVIEW pending (mcm1957) Changes requested by review have been applied, re-review could be done. must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review labels Mar 16, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Mar 25, 2024

@theknut

How shall we continue?
Do you need any help?
Did you notice the last comment and the provided PR?

Please check andfix or at least comment the issues listed earlier

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

reminder 8.4.2024

@theknut
Copy link
Contributor Author

theknut commented Mar 25, 2024

Sorry, I was sick and didn't find the time to review it. I'm back now and will do it in the coming days.

@github-actions github-actions bot added the *📬 a new comment has been added label Mar 25, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Mar 25, 2024

This a ABSOLUTELY no problem. Thanks for posteing a feedback.
Lets wait until you feel well again and have timme to work on the adapter.

get well soon

reminder 15.04.2024

@mcm1957 mcm1957 removed the *📬 a new comment has been added label Mar 25, 2024
@theknut
Copy link
Contributor Author

theknut commented Apr 11, 2024

All tasks have been resolved as per theknut/ioBroker.waterkotte-easycon@4932be8

@github-actions github-actions bot added the *📬 a new comment has been added label Apr 11, 2024
@mcm1957
Copy link
Collaborator

mcm1957 commented Apr 12, 2024

RE-CHECK!

@mcm1957
Copy link
Collaborator

mcm1957 commented Apr 12, 2024

@theknut

Some more feedback - sorry

Everything else looks good. Thanks for your effort.

Please add a comment when you have reviewed and fixed the suggestionsor at least commented the suggestions and you think the adapter is ready for a re-review!

reminder 19.4.2024

@mcm1957 mcm1957 added must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review and removed must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review *📬 a new comment has been added 19.4.2024 labels Apr 12, 2024
@theknut
Copy link
Contributor Author

theknut commented Apr 12, 2024

@github-actions github-actions bot added the *📬 a new comment has been added label Apr 12, 2024
Copy link

Automated adapter checker

ioBroker.waterkotte-easycon

Downloads Number of Installations (latest) - Test and Release
NPM

👍 No errors found

  • 👀 [W173] "@iobroker/adapter-core" (^3.0.4) should be 3.0.6 or newer - please update
  • 👀 [W400] Cannot find "waterkotte-easycon" in latest repository

Add comment "RE-CHECK!" to start check anew

@github-actions github-actions bot deleted a comment from mcm1957 Apr 12, 2024
@mcm1957 mcm1957 added lgtm Looks Good To Me and removed must be fixed The Adapter request got review/automatic feedback that is required to be fixed before another review *📬 a new comment has been added labels Apr 12, 2024
@mcm1957 mcm1957 merged commit 1e6e696 into ioBroker:master Apr 12, 2024
36 checks passed
@mcm1957
Copy link
Collaborator

mcm1957 commented Apr 12, 2024

This adapter has been released to latest repository and should be visible within 24h maximum.

Please create a thread at https://forum.iobroker.net/category/91/tester titled like "Test Adapter " to collect some user feedback and provide a link to this topic when requesting addition to stable repository later.

Note: If an other testing topic already exists, it' OK to continue using this topic too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-checked This PR was automatically checked for obvious criterias lgtm Looks Good To Me
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants