fix: readable error messages #1325

DBlanchard88 · 2024-06-14T20:56:36Z

Mapped the error codes to easier to read error messages
Created unit test to check functionality

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

netlify · 2024-06-14T20:56:52Z

✅ Deploy Preview for polite-licorice-3db33c ready!

Name	Link
🔨 Latest commit	`84c7248`
🔍 Latest deploy log	https://app.netlify.com/sites/polite-licorice-3db33c/deploys/6671ef126fe4320008f33106
😎 Deploy Preview	https://deploy-preview-1325--polite-licorice-3db33c.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2024-06-14T21:00:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.68%. Comparing base (1c530ab) to head (84c7248).
Report is 69 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1325      +/-   ##
==========================================
+ Coverage   73.69%   78.68%   +4.99%     
==========================================
  Files          32       36       +4     
  Lines        3140     2829     -311     
==========================================
- Hits         2314     2226      -88     
+ Misses        717      467     -250     
- Partials      109      136      +27

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

core/pkg/model/error.go

toddbaert

Tested locally, works as expected. Thanks @DBlanchard88 , this has been open for a while!

Approved with minor suggestions.

Co-authored-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: Dave <89858058+DBlanchard88@users.noreply.github.com>

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

core/pkg/model/error.go

Kavindu-Dodan

Nice improvement. I have this nit [1]

[1] - https://github.com/open-feature/flagd/pull/1325/files#r1644959707

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

🤖 I have created a release *beep* *boop* --- <details><summary>flagd: 0.11.0</summary> ## [0.11.0](flagd/v0.10.3...flagd/v0.11.0) (2024-06-27) ### ⚠ BREAKING CHANGES * support emitting errors from the bulk evaluator ([#1338](#1338)) ### 🐛 Bug Fixes * **deps:** update module buf.build/gen/go/open-feature/flagd/connectrpc/go to v1.16.2-20240215170432-1e611e2999cc.1 ([#1293](#1293)) ([2694e7f](2694e7f)) * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.4.0-20240215170432-1e611e2999cc.1 ([#1333](#1333)) ([494062f](494062f)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.34.2-20240215170432-1e611e2999cc.2 ([#1330](#1330)) ([32291ad](32291ad)) * **deps:** update module github.com/open-feature/flagd/core to v0.9.3 ([#1296](#1296)) ([1f7b8bd](1f7b8bd)) * **deps:** update module github.com/rs/cors to v1.11.0 ([#1299](#1299)) ([5f77541](5f77541)) * **deps:** update module github.com/spf13/cobra to v1.8.1 ([#1332](#1332)) ([c62bcb0](c62bcb0)) * **deps:** update module github.com/spf13/viper to v1.19.0 ([#1334](#1334)) ([1097b99](1097b99)) * **deps:** update module golang.org/x/net to v0.26.0 ([#1337](#1337)) ([83bdbb5](83bdbb5)) * **deps:** update opentelemetry-go monorepo ([#1314](#1314)) ([e9f1a7a](e9f1a7a)) * readable error messages ([#1325](#1325)) ([7ff33ef](7ff33ef)) ### ✨ New Features * support `FLAGD_DEBUG` / `--debug` / `-x` ([#1326](#1326)) ([298bd36](298bd36)) * support emitting errors from the bulk evaluator ([#1338](#1338)) ([b9c099c](b9c099c)) </details> <details><summary>flagd-proxy: 0.6.3</summary> ## [0.6.3](flagd-proxy/v0.6.2...flagd-proxy/v0.6.3) (2024-06-27) ### 🐛 Bug Fixes * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.4.0-20240215170432-1e611e2999cc.1 ([#1333](#1333)) ([494062f](494062f)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.34.2-20240215170432-1e611e2999cc.2 ([#1330](#1330)) ([32291ad](32291ad)) * **deps:** update module github.com/open-feature/flagd/core to v0.9.3 ([#1296](#1296)) ([1f7b8bd](1f7b8bd)) * **deps:** update module github.com/spf13/cobra to v1.8.1 ([#1332](#1332)) ([c62bcb0](c62bcb0)) * **deps:** update module github.com/spf13/viper to v1.19.0 ([#1334](#1334)) ([1097b99](1097b99)) * **deps:** update module golang.org/x/net to v0.26.0 ([#1337](#1337)) ([83bdbb5](83bdbb5)) * **deps:** update opentelemetry-go monorepo ([#1314](#1314)) ([e9f1a7a](e9f1a7a)) </details> <details><summary>core: 0.10.0</summary> ## [0.10.0](core/v0.9.3...core/v0.10.0) (2024-06-27) ### ⚠ BREAKING CHANGES * support emitting errors from the bulk evaluator ([#1338](#1338)) ### 🐛 Bug Fixes * **deps:** update module buf.build/gen/go/open-feature/flagd/grpc/go to v1.4.0-20240215170432-1e611e2999cc.1 ([#1333](#1333)) ([494062f](494062f)) * **deps:** update module buf.build/gen/go/open-feature/flagd/protocolbuffers/go to v1.34.2-20240215170432-1e611e2999cc.2 ([#1330](#1330)) ([32291ad](32291ad)) * **deps:** update module connectrpc.com/connect to v1.16.2 ([#1289](#1289)) ([8bacb7c](8bacb7c)) * **deps:** update module github.com/open-feature/open-feature-operator/apis to v0.2.43 ([#1331](#1331)) ([fecd769](fecd769)) * **deps:** update module golang.org/x/crypto to v0.24.0 ([#1335](#1335)) ([2a31a17](2a31a17)) * **deps:** update module golang.org/x/mod to v0.18.0 ([#1336](#1336)) ([5fa83f7](5fa83f7)) * **deps:** update opentelemetry-go monorepo ([#1314](#1314)) ([e9f1a7a](e9f1a7a)) * readable error messages ([#1325](#1325)) ([7ff33ef](7ff33ef)) ### ✨ New Features * add mandatory flags property in bulk response ([#1339](#1339)) ([b20266e](b20266e)) * support emitting errors from the bulk evaluator ([#1338](#1338)) ([b9c099c](b9c099c)) * support relative weighting for fractional evaluation ([#1313](#1313)) ([f82c094](f82c094)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

DBlanchard88 added 3 commits June 14, 2024 15:49

readableError messages

2f1af55

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

added unit testing

f41615c

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

changed wording

1b4a215

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

DBlanchard88 requested a review from a team as a code owner June 14, 2024 20:56

dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jun 14, 2024

toddbaert requested review from thisthat, bacherfl, Kavindu-Dodan, toddbaert and odubajDT June 15, 2024 16:10

toddbaert reviewed Jun 17, 2024

View reviewed changes

core/pkg/model/error.go Outdated Show resolved Hide resolved

toddbaert reviewed Jun 17, 2024

View reviewed changes

core/pkg/model/error.go Outdated Show resolved Hide resolved

toddbaert self-requested a review June 17, 2024 14:00

toddbaert approved these changes Jun 17, 2024

View reviewed changes

DBlanchard88 and others added 2 commits June 17, 2024 12:58

Update core/pkg/model/error.go

101101b

Co-authored-by: Todd Baert <todd.baert@dynatrace.com> Signed-off-by: Dave <89858058+DBlanchard88@users.noreply.github.com>

tweeked test

c32b56f

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Jun 18, 2024

DBlanchard88 added 2 commits June 18, 2024 12:10

making ReadableErrorMessage exportable

166cb7d

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

using ReadableErrorMessage in tests

d700a9b

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Jun 18, 2024

toddbaert approved these changes Jun 18, 2024

View reviewed changes

Kavindu-Dodan reviewed Jun 18, 2024

View reviewed changes

core/pkg/model/error.go Outdated Show resolved Hide resolved

Kavindu-Dodan approved these changes Jun 18, 2024

View reviewed changes

special case

5e55292

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

DBlanchard88 force-pushed the readable branch from 4382550 to 5e55292 Compare June 18, 2024 20:26

dosubot bot removed the size:M This PR changes 30-99 lines, ignoring generated files. label Jun 18, 2024

dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Jun 18, 2024

deleted txt files

1f75fb7

Signed-off-by: DBlanchard88 <davidblanchard88@gmail.com>

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Jun 18, 2024

Merge branch 'main' into readable

84c7248

toddbaert merged commit 7ff33ef into open-feature:main Jun 18, 2024
14 checks passed

github-actions bot mentioned this pull request Jun 18, 2024

chore: release main #1327

Merged

DBlanchard88 deleted the readable branch June 18, 2024 20:39

Kavindu-Dodan mentioned this pull request Jun 25, 2024

[FEATURE] Improved error messages #1100

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: readable error messages #1325

fix: readable error messages #1325

DBlanchard88 commented Jun 14, 2024

netlify bot commented Jun 14, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading

toddbaert left a comment

Kavindu-Dodan left a comment

fix: readable error messages #1325

fix: readable error messages #1325

Conversation

DBlanchard88 commented Jun 14, 2024

netlify bot commented Jun 14, 2024 • edited Loading

✅ Deploy Preview for polite-licorice-3db33c ready!

codecov bot commented Jun 14, 2024 • edited Loading

Codecov Report

toddbaert left a comment

Choose a reason for hiding this comment

Kavindu-Dodan left a comment

Choose a reason for hiding this comment

netlify bot commented Jun 14, 2024 •

edited

Loading

codecov bot commented Jun 14, 2024 •

edited

Loading