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.

Sign up for GitHub

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

Jump to bottom

Optionally tag CHIP_ERROR with source location #8340

Closed
kpschoedel opened this issue Jul 13, 2021 · 0 comments · Fixed by #8470
Closed

Optionally tag CHIP_ERROR with source location #8340

kpschoedel opened this issue Jul 13, 2021 · 0 comments · Fixed by #8470
Assignees
@kpschoedel

Comments

@kpschoedel
Copy link
Contributor

Problem

It can be difficult to identify the specific code that returned an error.

Proposed Solution

Convert CHIP_ERROR to a class that can (configurably) record the source location of an error, by including FILE and LINE in the …ERROR… constant macro expansions.

When not configured, this change must not increase the size of CHIP_ERROR or associated code.
@kpschoedel kpschoedel self-assigned this Jul 13, 2021
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 14, 2021
@kpschoedel
Make CHIP_ERROR a class type on Linux
8a15f69 
#### Problem

Having `CHIP_ERROR` be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Added a transitional configuration option to select whether
  `CHIP_ERROR` is an integer (as now) or a class type. Initially, only
  the Linux platform is configured with a class. The intent is to
  incrementally fix integer assumptions in other platforms, and finally
  remove the configuration flag and streamline the `ChipError` class.

- Since logging calls had to modified anyway, added `FormatError()`,
  which can be configured to either return an integer value or a string
  (via `ErrorStr()`).

- Fixed some actual type errors, where non-CHIP_ERROR values were
  treated as CHIP_ERRORs. (None appear to have had more serious
  consequences than a nonsense message from ErrorStr().)

#### Testing

- Modified affected unit tests.
- Sanity check using chip-tool.
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 14, 2021
@kpschoedel
Make CHIP_ERROR a class type on Linux
a2e94f7 
#### Problem

Having `CHIP_ERROR` be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Added a transitional configuration option to select whether
  `CHIP_ERROR` is an integer (as now) or a class type. Initially, only
  the Linux platform is configured with a class. The intent is to
  incrementally fix integer assumptions in other platforms, and finally
  remove the configuration flag and streamline the `ChipError` class.

- Since logging calls had to modified anyway, added `FormatError()`,
  which can be configured to either return an integer value or a string
  (via `ErrorStr()`).

- Fixed some actual type errors, where non-CHIP_ERROR values were
  treated as CHIP_ERRORs. (None appear to have had more serious
  consequences than a nonsense message from ErrorStr().)

#### Testing

- Modified affected unit tests.
- Sanity check using chip-tool.
@kpschoedel kpschoedel mentioned this issue Jul 14, 2021
Merged
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 14, 2021
@kpschoedel
Make CHIP_ERROR a class type on Linux
f918e70 
#### Problem

Having `CHIP_ERROR` be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Added a transitional configuration option to select whether
  `CHIP_ERROR` is an integer (as now) or a class type. Initially, only
  the Linux platform is configured with a class. The intent is to
  incrementally fix integer assumptions in other platforms, and finally
  remove the configuration flag and streamline the `ChipError` class.

- Since logging calls had to modified anyway, added `FormatError()`,
  which can be configured to either return an integer value or a string
  (via `ErrorStr()`).

- Fixed some actual type errors, where non-CHIP_ERROR values were
  treated as CHIP_ERRORs. (None appear to have had more serious
  consequences than a nonsense message from ErrorStr().)

#### Testing

- Modified affected unit tests.
- Sanity check using chip-tool.
mspang pushed a commit that referenced this issue Jul 15, 2021
@kpschoedel
Make CHIP_ERROR a class type on Linux (#8383)
15669b6 
* Make CHIP_ERROR a class type on Linux

#### Problem

Having `CHIP_ERROR` be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue #8340).

#### Change overview

- Added a transitional configuration option to select whether
  `CHIP_ERROR` is an integer (as now) or a class type. Initially, only
  the Linux platform is configured with a class. The intent is to
  incrementally fix integer assumptions in other platforms, and finally
  remove the configuration flag and streamline the `ChipError` class.

- Since logging calls had to modified anyway, added `FormatError()`,
  which can be configured to either return an integer value or a string
  (via `ErrorStr()`).

- Fixed some actual type errors, where non-CHIP_ERROR values were
  treated as CHIP_ERRORs. (None appear to have had more serious
  consequences than a nonsense message from ErrorStr().)

#### Testing

- Modified affected unit tests.
- Sanity check using chip-tool.

* review

* review

* zap regen
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 15, 2021
@kpschoedel
Make CHIP_ERROR a class type on cc13x2_26x2, EFR32, QPG.
9da47f1 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on cc13x2_26x2, EFR32, QPG.

- Remove `operator bool()` (requested in project-chip#8383 review).

#### Testing

Existing tests should confirm no change to functionality.
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 15, 2021
@kpschoedel
Make CHIP_ERROR a class type on cc13x2_26x2, EFR32, QPG.
f813d80 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on cc13x2_26x2, EFR32, QPG.

- Remove `operator bool()` (requested in project-chip#8383 review).

#### Testing

Existing tests should confirm no change to functionality.
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 15, 2021
@kpschoedel
Make CHIP_ERROR a class type on cc13x2_26x2, EFR32, QPG.
b230af4 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on cc13x2_26x2, EFR32, QPG.

- Remove `operator bool()` (requested in project-chip#8383 review).

#### Testing

Existing tests should confirm no change to functionality.
@kpschoedel kpschoedel mentioned this issue Jul 15, 2021
Merged
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 16, 2021
@kpschoedel
Make CHIP_ERROR a class type ESP32.
3554cf8 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on ESP32.

#### Testing

Passes esp32_qemu_tests.sh
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 16, 2021
@kpschoedel
Make CHIP_ERROR a class type ESP32.
122a85f 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on ESP32.

#### Testing

Passes esp32_qemu_tests.sh
bzbarsky-apple pushed a commit that referenced this issue Jul 16, 2021
@kpschoedel
Make CHIP_ERROR a class type on cc13x2_26x2, EFR32, QPG. (#8446)
0e54870 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue #8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on cc13x2_26x2, EFR32, QPG.

- Remove `operator bool()` (requested in #8383 review).

#### Testing

Existing tests should confirm no change to functionality.
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 17, 2021
@kpschoedel
Make CHIP_ERROR a class type ESP32.
a451446 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on ESP32.

#### Testing

Passes esp32_qemu_tests.sh
@kpschoedel kpschoedel mentioned this issue Jul 17, 2021
Merged
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 17, 2021
@kpschoedel
Optionally tag CHIP_ERROR with source location
e65807a 
#### Problem

It can be difficult to identify the specific code that returned an error.

#### Change overview

Added a configuration option, `CHIP_CONFIG_ERROR_SOURCE`. When this is
enabled (and assuming `CHIP_ERROR` is a class, which should eventually
be true for all builds), `…_ERROR_…` constant macros record the source
`__FILE__` and `__LINE__` where they are used, in the `CHIP_ERROR` object.

Unless `CHIP_CONFIG_SHORT_ERROR_STR` is configured, the source file and
line appear in the result of `ErrorStr()`.

Fixes project-chip#8340 _Optionally tag CHIP_ERROR with source location_

#### Testing

- revised `src/lib/support/tests/TestErrorStr.cpp`
@kpschoedel kpschoedel mentioned this issue Jul 17, 2021
Merged
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 19, 2021
@kpschoedel
Optionally tag CHIP_ERROR with source location
bfd0772 
#### Problem

It can be difficult to identify the specific code that returned an error.

#### Change overview

Added a configuration option, `CHIP_CONFIG_ERROR_SOURCE`. When this is
enabled (and assuming `CHIP_ERROR` is a class, which should eventually
be true for all builds), `…_ERROR_…` constant macros record the source
`__FILE__` and `__LINE__` where they are used, in the `CHIP_ERROR` object.

Unless `CHIP_CONFIG_SHORT_ERROR_STR` is configured, the source file and
line appear in the result of `ErrorStr()`.

Fixes project-chip#8340 _Optionally tag CHIP_ERROR with source location_

#### Testing

- revised `src/lib/support/tests/TestErrorStr.cpp`
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 19, 2021
@kpschoedel
Optionally tag CHIP_ERROR with source location
e5dec69 
#### Problem

It can be difficult to identify the specific code that returned an error.

#### Change overview

Added a configuration option, `CHIP_CONFIG_ERROR_SOURCE`. When this is
enabled (and assuming `CHIP_ERROR` is a class, which should eventually
be true for all builds), `…_ERROR_…` constant macros record the source
`__FILE__` and `__LINE__` where they are used, in the `CHIP_ERROR` object.

Unless `CHIP_CONFIG_SHORT_ERROR_STR` is configured, the source file and
line appear in the result of `ErrorStr()`.

Fixes project-chip#8340 _Optionally tag CHIP_ERROR with source location_

#### Testing

- revised `src/lib/support/tests/TestErrorStr.cpp`
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 19, 2021
@kpschoedel
Make CHIP_ERROR a class type on ESP32.
240f527 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on ESP32.

#### Testing

Passes esp32_qemu_tests.sh
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 19, 2021
@kpschoedel
Optionally tag CHIP_ERROR with source location
db50b37 
#### Problem

It can be difficult to identify the specific code that returned an error.

#### Change overview

Added a configuration option, `CHIP_CONFIG_ERROR_SOURCE`. When this is
enabled (and assuming `CHIP_ERROR` is a class, which should eventually
be true for all builds), `…_ERROR_…` constant macros record the source
`__FILE__` and `__LINE__` where they are used, in the `CHIP_ERROR` object.

Unless `CHIP_CONFIG_SHORT_ERROR_STR` is configured, the source file and
line appear in the result of `ErrorStr()`.

Fixes project-chip#8340 _Optionally tag CHIP_ERROR with source location_

#### Testing

- revised `src/lib/support/tests/TestErrorStr.cpp`
mspang pushed a commit that referenced this issue Jul 21, 2021
@kpschoedel
Optionally tag CHIP_ERROR with source location (#8470)
57874d4 
* Optionally tag CHIP_ERROR with source location

#### Problem

It can be difficult to identify the specific code that returned an error.

#### Change overview

Added a configuration option, `CHIP_CONFIG_ERROR_SOURCE`. When this is
enabled (and assuming `CHIP_ERROR` is a class, which should eventually
be true for all builds), `…_ERROR_…` constant macros record the source
`__FILE__` and `__LINE__` where they are used, in the `CHIP_ERROR` object.

Unless `CHIP_CONFIG_SHORT_ERROR_STR` is configured, the source file and
line appear in the result of `ErrorStr()`.

Fixes #8340 _Optionally tag CHIP_ERROR with source location_

#### Testing

- revised `src/lib/support/tests/TestErrorStr.cpp`

* Convert python interface

* review

* review

* Modify ReturnErrorOnFailure et al to accept CHIP_ERROR class or integer

* Fix flaky unit test

* restyle
mspang pushed a commit that referenced this issue Jul 21, 2021
@kpschoedel
Make CHIP_ERROR a class type on ESP32 (#8469)
162366f 
* Make CHIP_ERROR a class type on ESP32.

#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue #8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on ESP32.

#### Testing

Passes esp32_qemu_tests.sh

* review
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 26, 2021
@kpschoedel
Make CHIP_ERROR a class type on nrfconnect
c0f44aa 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on nrfconnect.

#### Testing

Existing tests should confirm no change to functionality.
@kpschoedel kpschoedel mentioned this issue Jul 28, 2021
Merged
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 28, 2021
@kpschoedel
Make CHIP_ERROR a class type on nrfconnect
cb32df2 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on nrfconnect.

#### Testing

Existing tests should confirm no change to functionality.
mspang pushed a commit that referenced this issue Jul 28, 2021
@kpschoedel
Make CHIP_ERROR a class type on nrfconnect (#8652)
fcbe2e0 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue #8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on nrfconnect.

#### Testing

Existing tests should confirm no change to functionality.
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 29, 2021
@kpschoedel
Make CHIP_ERROR a class type on k32w, mbed, telink
4da7880 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on k32w, mbed, and telink.

#### Testing

Existing tests should confirm no change to functionality.
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 30, 2021
@kpschoedel
Make CHIP_ERROR a class type on k32w, mbed, telink
d6cce6a 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on k32w, mbed, and telink.

#### Testing

Existing tests should confirm no change to functionality.
kpschoedel added a commit to kpschoedel/connectedhomeip that referenced this issue Jul 30, 2021
@kpschoedel
Make CHIP_ERROR a class type on Darwin
227c21e 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on k32w, mbed, and telink.

#### Testing

Existing tests should confirm no change to functionality.
@kpschoedel kpschoedel mentioned this issue Jul 31, 2021
Merged
andy31415 pushed a commit that referenced this issue Aug 3, 2021
@kpschoedel
Make CHIP_ERROR a class type on k32w, mbed, telink (#8745)
9ca9d47 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue #8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on k32w, mbed, and telink.

#### Testing

Existing tests should confirm no change to functionality.
nikita-s-wrk pushed a commit to nikita-s-wrk/connectedhomeip that referenced this issue Sep 23, 2021
@kpschoedel
Make CHIP_ERROR a class type on Linux (project-chip#8383)
2c3b662 
* Make CHIP_ERROR a class type on Linux

#### Problem

Having `CHIP_ERROR` be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Added a transitional configuration option to select whether
  `CHIP_ERROR` is an integer (as now) or a class type. Initially, only
  the Linux platform is configured with a class. The intent is to
  incrementally fix integer assumptions in other platforms, and finally
  remove the configuration flag and streamline the `ChipError` class.

- Since logging calls had to modified anyway, added `FormatError()`,
  which can be configured to either return an integer value or a string
  (via `ErrorStr()`).

- Fixed some actual type errors, where non-CHIP_ERROR values were
  treated as CHIP_ERRORs. (None appear to have had more serious
  consequences than a nonsense message from ErrorStr().)

#### Testing

- Modified affected unit tests.
- Sanity check using chip-tool.

* review

* review

* zap regen
nikita-s-wrk pushed a commit to nikita-s-wrk/connectedhomeip that referenced this issue Sep 23, 2021
@kpschoedel
Make CHIP_ERROR a class type on cc13x2_26x2, EFR32, QPG. (project-chi…
029b818 
…p#8446)

#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on cc13x2_26x2, EFR32, QPG.

- Remove `operator bool()` (requested in project-chip#8383 review).

#### Testing

Existing tests should confirm no change to functionality.
nikita-s-wrk pushed a commit to nikita-s-wrk/connectedhomeip that referenced this issue Sep 23, 2021
@kpschoedel
Optionally tag CHIP_ERROR with source location (project-chip#8470)
6e6a6f0 
* Optionally tag CHIP_ERROR with source location

#### Problem

It can be difficult to identify the specific code that returned an error.

#### Change overview

Added a configuration option, `CHIP_CONFIG_ERROR_SOURCE`. When this is
enabled (and assuming `CHIP_ERROR` is a class, which should eventually
be true for all builds), `…_ERROR_…` constant macros record the source
`__FILE__` and `__LINE__` where they are used, in the `CHIP_ERROR` object.

Unless `CHIP_CONFIG_SHORT_ERROR_STR` is configured, the source file and
line appear in the result of `ErrorStr()`.

Fixes project-chip#8340 _Optionally tag CHIP_ERROR with source location_

#### Testing

- revised `src/lib/support/tests/TestErrorStr.cpp`

* Convert python interface

* review

* review

* Modify ReturnErrorOnFailure et al to accept CHIP_ERROR class or integer

* Fix flaky unit test

* restyle
nikita-s-wrk pushed a commit to nikita-s-wrk/connectedhomeip that referenced this issue Sep 23, 2021
@kpschoedel
Make CHIP_ERROR a class type on ESP32 (project-chip#8469)
e97cb58 
* Make CHIP_ERROR a class type on ESP32.

#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on ESP32.

#### Testing

Passes esp32_qemu_tests.sh

* review
nikita-s-wrk pushed a commit to nikita-s-wrk/connectedhomeip that referenced this issue Sep 23, 2021
@kpschoedel
Make CHIP_ERROR a class type on nrfconnect (project-chip#8652)
f7f4c0a 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on nrfconnect.

#### Testing

Existing tests should confirm no change to functionality.
nikita-s-wrk pushed a commit to nikita-s-wrk/connectedhomeip that referenced this issue Sep 23, 2021
@kpschoedel
Make CHIP_ERROR a class type on k32w, mbed, telink (project-chip#8745)
42ad9d7 
#### Problem

Having CHIP_ERROR be a class type would provide (a) type safety,
and (b) the ability to trace the source of errors (issue project-chip#8340).

#### Change overview

- Enable `CHIP_CONFIG_ERROR_CLASS` on k32w, mbed, and telink.

#### Testing

Existing tests should confirm no change to functionality.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kpschoedel kpschoedel

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Optionally tag CHIP_ERROR with source location kpschoedel/connectedhomeip
1 participant
@kpschoedel