Graceful load JSON and Digest:CRC Modules #1066

sidey79 · 2022-01-18T22:01:22Z

Please check if the PR fulfills these requirements

Tests for the changes have been added / modified (needed for for bug fixes / features)
commandref has been added / updated (needed for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

What is the current behavior?
(You can also link to an open issue here, if this describes the current behavior)

If Digest::CRC Module is not available, the Module is loaded and startup errors are logged

BEGIN failed--compilation aborted at ./FHEM/00_SIGNALduino.pm line 27, <$fh> line 49.
 Can't locate Digest/CRC.pm in @INC (you may need to install the Digest::CRC module) (@INC contains: ./lib ./FHEM . /etc/perl /usr/local/lib/arm-linux-gnueabihf/perl/5.28.1 /usr/local/share/perl/5.28.1 /usr/lib/arm-linux-gnueabihf/perl5/5.28 /usr/share/perl5 /usr/lib/arm-linux-gnueabihf/perl/5.28 /usr/share/perl/5.28 /usr/local/lib/site_perl /usr/lib/arm-linux-gnueabihf/perl-base ./FHEM/lib) at ./FHEM/00_SIGNALduino.pm line 27, <$fh> line 49.
2022.01.18 20:58:57.371 1: reload: Error:Modul 00_SIGNALduino deactivated:

What is the new behavior (if this is a feature change)?

The SIGNALduino Module no longer depends on the CRC Module

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

maybe it causes an error in the libs, because they require CRC for some subs

Other information:
https://forum.fhem.de/index.php/topic,125541.0.html
https://forum.fhem.de/index.php/topic,58397.msg1201448.html#msg1201448

#927

codecov · 2022-01-18T22:03:07Z

Codecov Report

Merging #1066 (c9fa62f) into master (bfd6b06) will increase coverage by 0.27%.
The diff coverage is 93.75%.

@@            Coverage Diff             @@
##           master    #1066      +/-   ##
==========================================
+ Coverage   62.18%   62.45%   +0.27%     
==========================================
  Files         126      129       +3     
  Lines        9332     9371      +39     
  Branches     1475     1478       +3     
==========================================
+ Hits         5803     5853      +50     
+ Misses       2429     2415      -14     
- Partials     1100     1103       +3

Flag	Coverage Δ
fhem	`53.83% <87.50%> (+0.35%)`	⬆️
modules	`62.45% <93.75%> (+0.27%)`	⬆️
perl	`91.85% <100.00%> (+0.01%)`	⬆️
unittests	`62.45% <93.75%> (+0.27%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
t/FHEM/00_SIGNALduino/01_SIGNALduino_Parse_MN.t	`100.00% <ø> (ø)`
FHEM/00_SIGNALduino.pm	`64.10% <85.71%> (+1.10%)`	⬆️
FHEM/lib/SD_Protocols.pm	`79.81% <100.00%> (+0.09%)`	⬆️
t/FHEM/00_SIGNALduino/00_SIGNALduino_initialize.t	`100.00% <100.00%> (ø)`
FHEM/10_SD_Rojaflex.pm	`68.69% <0.00%> (-2.85%)`	⬇️
t/FHEM/14_SD_WS07/09_parseDatat.t
t/FHEM/14_FLAMINGO/09_parseDatat.t	`80.00% <0.00%> (ø)`
t/FHEM/14_FLAMINGO/00_load.t	`100.00% <0.00%> (ø)`
t/FHEM/14_SD_AS/00_load.t	`100.00% <0.00%> (ø)`
t/FHEM/14_SD_BELL/09_parseDatat.t	`80.00% <0.00%> (ø)`
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bfd6b06...c9fa62f. Read the comment docs.

Handling of missing modules changed

Handling of missing protocols changed

added module for unittest

remove requirement Digest::CRC

Fixed require check

- check json

- remove checks for missing Digest::CRC

…into missing-modules

elektron-bbs · 2022-01-19T16:48:59Z

So ganz "Graceful" ist das noch nicht :-)
So, wie es jetzt ist, schmiert FHEM bei jedem Versuch Digest::CRC zu nutzen, ab:

Can't locate object method "new" via package "Digest::CRC" at FHEM/lib/SD_Protocols.pm line 1989.
2022.01.19 15:02:25.304 1: Including fhem.cfg
2022.01.19 15:02:25.709 3: WEB: port 8083 opened

und Dank systemd passiert das dann alle paar Sekunden wieder:

2022.01.19 15:02:49.125 3: LaCrosseGateway device opened
Can't locate object method "new" via package "Digest::CRC" at FHEM/lib/SD_Protocols.pm line 1989.
2022.01.19 15:02:51.274 1: Including fhem.cfg
2022.01.19 15:02:51.589 3: WEB: port 8083 opened
...
2022.01.19 15:03:14.296 3: sduino_USB0: CheckVersionResp, enable receiver (XE) 
Can't locate object method "new" via package "Digest::CRC" at FHEM/lib/SD_Protocols.pm line 1989.
2022.01.19 15:03:15.634 1: Including fhem.cfg
2022.01.19 15:03:15.858 3: WEB: port 8083 opened

Es müsste auf jeden Fall in jeder sub, die Digest::CRC verwendet ein return in folgender Art hinein:

  return ( 1,'ConvLaCrosse, Modul CRC not loaded, please install modul Digest::CRC' )
    if (!HAS_DigestCRC);

Damit die Fehlermeldungen auch sichtbar werden, hatte ich in der 00_SIGNALduino.pm sub SIGNALduino_Parse_MN schon mal diese Zeilen angepasst:

    if ($#methodReturn != 0) {
      my $vb = $methodReturn[0];
      $hash->{logMethod}->($name, $vb, qq{$name: Parse_MN, Error! method $methodReturn[1]});
      next mnIDLoop;
    }

sidey79 · 2022-01-19T19:35:24Z

@elektron-bbs

Mach doch einen commit mit den Anpassung.

Ich war gestern ohnehin überrascht, dass es nicht mehr so ist, wie wir es in #927 hinterlassen hatten.

elektron-bbs · 2022-01-19T19:57:54Z

Wir hatten ja in dem Issue keine Übereinstimmung gefunden, deshalb war alles so geblieben, wie es war.
Ich mache ein commit.

elektron-bbs · 2022-01-21T14:50:21Z

Falls wir das mit meiner Änderung so lassen wollen, müssten wir sicher in der SD_Protocols.pm noch die verbose-level anpassen.

sidey79 · 2022-01-21T18:30:41Z

Falls wir das mit meiner Änderung so lassen wollen, müssten wir sicher in der SD_Protocols.pm noch die verbose-level anpassen.

Was meinst Du damit?
Der Returncode 1 ist ein Fehlercode und kein VerboseLevel :)

elektron-bbs · 2022-01-21T19:40:26Z

Ich habe diesen jetzt aber gleich für den Verbose-Level verwendet

    if ($#methodReturn != 0) {
      my $vb = $methodReturn[0];
      $hash->{logMethod}->($name, $vb, qq{$name: Parse_MN, Error! method $methodReturn[1]});
      next mnIDLoop;
    }

da wir sonst Fehlermeldungen nie zu sehen bekommen.

sidey79 · 2022-01-21T20:02:13Z

da wir sonst Fehlermeldungen nie zu sehen bekommen.

Habe ich gesehen, so ist das nicht gedacht.
Eher so wie
exit(0) kein Fehler
exit(1) einen Fehlercode 1 liefert
usw dann auch Fehlercode 2,3,4,5,6

spellfix

…into missing-modules

Logging fehlendes CRC Modul angepasst

…into missing-modules

sidey79 · 2022-01-22T00:17:02Z

Sieht für mich jetzt gut aus:

2022.01.22 01:16:12.899 4: dummyDuino: Parse_MN, 2-FSK Protocol id 116.1 WH57 msg 1E6C20B00C1618FF99FF0458FFFFA9FF015B0000 not match (?^:^57)
2022.01.22 01:16:12.893 4: dummyDuino: Parse_MN, 2-FSK Protocol id 116 WH57 msg 1E6C20B00C1618FF99FF0458FFFFA9FF015B0000 not match (?^:^57)
2022.01.22 01:16:12.887 1: dummyDuino: Parse_MN, Error! method ConvBresser_6in1, missing module , please install modul Digest::CRC
2022.01.22 01:16:12.881 4: dummyDuino: Parse_MN, Found 2-FSK Protocol id 115 -> Bresser 6in1
2022.01.22 01:16:12.875 4: dummyDuino: Parse_MN, Error! id 112 msg=1E6C20B00C1618FF99FF0458FFFFA9FF015B0000, message is to long
2022.01.22 01:16:12.870 4: dummyDuino: Parse_MN, Error! id 109 msg=1E6C20B00C1618FF99FF0458FFFFA9FF015B0000, message is to long
2022.01.22 01:16:12.864 4: dummyDuino: Parse_MN, Error! id 108 msg=1E6C20B00C1618FF99FF0458FFFFA9FF015B0000, message is to short
2022.01.22 01:16:12.858 4: dummyDuino: Parse_MN, 2-FSK Protocol id 107.1 WH51 868.35 MHz msg 1E6C20B00C1618FF99FF0458FFFFA9FF015B0000 not match (?^:^51)
2022.01.22 01:16:12.852 4: dummyDuino: Parse_MN, 2-FSK Protocol id 107 WH51 433.92 MHz msg 1E6C20B00C1618FF99FF0458FFFFA9FF015B0000 not match (?^:^51)
2022.01.22 01:16:12.846 4: dummyDuino: Parse_MN, 2-FSK Protocol id 103 Lacrosse mode 2 msg 1E6C20B00C1618FF99FF0458FFFFA9FF015B0000 not match (?^:^9)
2022.01.22 01:16:12.840 4: dummyDuino: Parse_MN, GFSK Protocol id 102 KoppFreeControl msg 1E6C20B00C1618FF99FF0458FFFFA9FF015B0000 not match (?^:^0)
2022.01.22 01:16:12.834 1: dummyDuino: Parse_MN, Error! method ConvPCA301, missing module , please install modul Digest::CRC
2022.01.22 01:16:12.828 4: dummyDuino: Parse_MN, Found 2-FSK Protocol id 101 -> PCA 301
2022.01.22 01:16:12.822 4: dummyDuino: Parse_MN, 2-FSK Protocol id 100 Lacrosse mode 1 msg 1E6C20B00C1618FF99FF0458FFFFA9FF015B0000 not match (?^:^9)

Test Bresser 6in1 ergänzt

…into missing-modules

elektron-bbs · 2022-01-22T09:54:21Z

So geht es natürlich auch erstmal.
Ich finde aber die Variante, die Zahl direkt als Verbose-Level zu verwenden, flexibler. Wenn wir mal eine andere Meldung im Log sehen wollen, müssen wir immer erst das Regex ergänzen.

Test entfernt, in dem Digest::CRC entladen wird, da nicht funktional

…into missing-modules

sidey79 · 2022-01-22T17:02:28Z

@elektron-bbs

Ich würde es auf die schnelle erst einmal so belassen und dann ggf. auch heute noch SVN aktualisieren

elektron-bbs

Eigentlich ungern... aber weil du es bist :-)

Release 3.5.3 00_SIGNALduino.pm: feature: Handling of missing modules changed SD_Protocols.pm feature: Graceful load JSON and Digest:CRC Modules (#1066) 14_SD_UT.pm bugfix: fix buttons P90 (#1060)

sidey79 added bug enhancement labels Jan 18, 2022

sidey79 added 3 commits January 18, 2022 23:08

00_SIGNALduino.pm

84307a2

Handling of missing modules changed

lib/SD_Protocols.pm

55c6b6c

Handling of missing protocols changed

cpamnfile

8f30747

added module for unittest

sidey79 force-pushed the missing-modules branch from 39594bd to 8f30747 Compare January 18, 2022 22:10

actions-user and others added 7 commits January 18, 2022 22:11

Update Versiondate

4feed62

00_SIGNALduino.pm

f917e22

remove requirement Digest::CRC

SD_Protocols:

57f1e5d

Fixed require check

00_SIGNALduino.pm

b6bfc18

- check json

00_SIGNALduino_initialite.t

151a6e2

- remove checks for missing Digest::CRC

Merge branch 'missing-modules' of https://github.com/RFD-FHEM/RFFHEM …

ed4d5f3

…into missing-modules

Update Versiondate

da8bcb7

sidey79 requested review from elektron-bbs and HomeAutoUser January 18, 2022 23:03

elektron-bbs and others added 4 commits January 19, 2022 21:11

completion load Digest::CRC

75f2dc3

Update Versiondate

ffc4b1e

Merge branch 'master' into missing-modules

6aabcae

Update Versiondate

30163a2

sidey79 and others added 3 commits January 21, 2022 22:56

SD_Protocos.pm

114f93b

spellfix

Merge branch 'missing-modules' of https://github.com/RFD-FHEM/RFFHEM …

20df03e

…into missing-modules

Update Versiondate

2a36efc

sidey79 and others added 3 commits January 21, 2022 23:55

00_SIGNALduino.pm

8c0f679

Logging fehlendes CRC Modul angepasst

Merge branch 'missing-modules' of https://github.com/RFD-FHEM/RFFHEM …

21afe3f

…into missing-modules

Update Versiondate

4947f08

sidey79 and others added 3 commits January 22, 2022 01:20

00_SIGNALduino.pm

2c041a9

Test Bresser 6in1 ergänzt

Merge branch 'missing-modules' of https://github.com/RFD-FHEM/RFFHEM …

8a068c5

…into missing-modules

Update Versiondate

2a1b791

sidey79 and others added 3 commits January 22, 2022 17:37

01_SIGNALduino_Parse_MN.t

31885cc

Test entfernt, in dem Digest::CRC entladen wird, da nicht funktional

Merge branch 'missing-modules' of https://github.com/RFD-FHEM/RFFHEM …

2b03550

…into missing-modules

Update Versiondate

c9fa62f

elektron-bbs approved these changes Jan 22, 2022

View reviewed changes

sidey79 merged commit c6d7068 into master Jan 22, 2022

sidey79 deleted the missing-modules branch January 22, 2022 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Graceful load JSON and Digest:CRC Modules #1066

Graceful load JSON and Digest:CRC Modules #1066

sidey79 commented Jan 18, 2022 •

edited

Loading

codecov bot commented Jan 18, 2022 •

edited

Loading

elektron-bbs commented Jan 19, 2022

sidey79 commented Jan 19, 2022

elektron-bbs commented Jan 19, 2022

elektron-bbs commented Jan 21, 2022

sidey79 commented Jan 21, 2022

elektron-bbs commented Jan 21, 2022

sidey79 commented Jan 21, 2022

sidey79 commented Jan 22, 2022

elektron-bbs commented Jan 22, 2022

sidey79 commented Jan 22, 2022

elektron-bbs left a comment

Graceful load JSON and Digest:CRC Modules #1066

Graceful load JSON and Digest:CRC Modules #1066

Conversation

sidey79 commented Jan 18, 2022 • edited Loading

codecov bot commented Jan 18, 2022 • edited Loading

Codecov Report

elektron-bbs commented Jan 19, 2022

sidey79 commented Jan 19, 2022

elektron-bbs commented Jan 19, 2022

elektron-bbs commented Jan 21, 2022

sidey79 commented Jan 21, 2022

elektron-bbs commented Jan 21, 2022

sidey79 commented Jan 21, 2022

sidey79 commented Jan 22, 2022

elektron-bbs commented Jan 22, 2022

sidey79 commented Jan 22, 2022

elektron-bbs left a comment

Choose a reason for hiding this comment

sidey79 commented Jan 18, 2022 •

edited

Loading

codecov bot commented Jan 18, 2022 •

edited

Loading