Empty String `""` Code Review Warning Annotation #31

0x4007 · 2024-03-09T11:49:55Z

Annotate them with warnings in code review to more closely scrutinize the logic that interacts with the variable.

Rationale

I see a lot of abuse for empty strings. It makes code logic sloppy and more error prone. But since there are some legitimate uses for empty strings, we will just set a warning instead of error?

Examples

https://github.com/ubiquity/audit.ubq.fi/blob/08fba85a9a592ca2bda5eaeaa2ff3b9fdd4632be/static/scripts/audit-report/audit.ts#L26C1-L27C21

Should be unset (which implies undefined) instead of passing an empty string as a credential or URL. Then the code should check if the value is truthy before expecting authentication.

let REPOSITORY_URL;
let GITHUB_PAT;

https://github.com/ubiquity/ubiquibot-kernel/blame/c553d5a7866c1ef76d4f589d8095c8bb751cbd49/src/github/types/config.ts#L29

Should be value.ref ?? "@" + value.ref as I'm assuming the developer never expected the "" value to be returned there.

https://github.com/ubiquity/pay.ubq.fi/pull/189/files#r1518549017

This shouldn't have been here at all. It's not a valid RPC endpoint.

From codebase search: https://github.com/search?q=org%3Aubiquity+%5C%22%5C%22+language%3ATypeScript&type=code

The text was updated successfully, but these errors were encountered:

Keyrxng · 2024-03-25T06:54:45Z

/start

ubiquibot · 2024-03-25T06:54:51Z



Deadline Mon, Mar 25, 8:54 AM UTC

Registered Wallet
0xAe5D1F192013db889b1e2115A370aB133f359765

Tips:

Use /wallet 0x0000...0000 if you want to update your registered payment wallet address.
Be sure to open a draft pull request as soon as possible to communicate updates on your progress.
Be sure to provide timely updates to us when requested, or you will be automatically unassigned from the task.

Keyrxng · 2024-06-04T14:11:52Z

/stop if it is still an open task I will pick it back up. Feel free to ref my PR if anyone wants to take this

ubiquibot · 2024-06-04T14:12:00Z

+ You have been unassigned from the task

Sadaf-A · 2024-07-05T21:19:29Z

/start

ubiquibot · 2024-07-05T21:19:35Z



Warning!  This task was created over 118 days ago. Please confirm that this issue specification is accurate before starting.
Deadline Fri, Jul 5, 11:19 PM UTC

Registered Wallet
0x0BEd00438D57d07E3667b85Fa8EB86Af147C7025

Tips:

Use /wallet 0x0000...0000 if you want to update your registered payment wallet address.
Be sure to open a draft pull request as soon as possible to communicate updates on your progress.
Be sure to provide timely updates to us when requested, or you will be automatically unassigned from the task.

ubiquibot · 2024-08-16T04:33:57Z

# These linked pull requests are closed:  <a href="https://github.com/ubiquity/ts-template/pull/36">#36</a>

jordan-ae · 2024-09-04T16:20:58Z

/start

ubiquity-os · 2024-09-04T16:21:06Z

Warning! This task was created over 179 days ago. Please confirm that this issue specification is accurate before starting. Deadline Wed, Sep 4, 6:21 PM UTC Registered Wallet 0x2F05fD58023B0a95d1866aa0A3b672cEf05945c5

Tips:

Use /wallet 0x0000...0000 if you want to update your registered payment wallet address.
Be sure to open a draft pull request as soon as possible to communicate updates on your progress.
Be sure to provide timely updates to us when requested, or you will be automatically unassigned from the task.

ubiquity-os · 2024-09-10T05:15:51Z

@jordan-ae, this task has been idle for a while. Please provide an update.

jordan-ae · 2024-09-12T10:13:59Z

/stop

ubiquity-os · 2024-09-12T10:14:07Z

# These linked pull requests are closed:  https://github.com/ubiquity/ts-template/pull/57

ubiquity-os · 2024-10-08T21:16:38Z

! You have reached your max task limit. Please close out some tasks before assigning new ones.

ubiquity-os · 2024-10-08T21:20:22Z

! Failed to run comment evaluation. TypeError: Cannot read properties of undefined (reading 'wordValue')

ubiquity-os · 2024-10-08T22:42:55Z

! You have reached your max task limit. Please close out some tasks before assigning new ones.

ubiquity-os · 2024-10-09T00:02:46Z

! You have reached your max task limit. Please close out some tasks before assigning new ones.

ubiquity-os · 2024-10-09T00:17:57Z

! You have reached your max task limit. Please close out some tasks before assigning new ones.

ubiquity-os · 2024-10-09T00:18:11Z

! Failed to run comment evaluation. TypeError: Cannot read properties of undefined (reading 'wordValue')

ubiquity-os · 2024-10-09T00:18:11Z

@0x4007 the deadline is at Wed, Oct 9, 2:18 AM UTC

ubiquity-os · 2024-10-09T00:18:29Z

! Failed to run comment evaluation. TypeError: Cannot read properties of undefined (reading 'wordValue')

0x4007 · 2024-10-09T00:42:54Z

! Failed to run comment evaluation. TypeError: Cannot read properties of undefined (reading 'wordValue')

@gentlementlegen can you fix today and leverage Whilefoo environment config switcher

ubiquity-os · 2024-10-18T07:47:21Z

[ 156.074 WXDAI ]
@0x4007

Contributions Overview

View	Contribution	Count	Reward
Issue	Task	1	100
Issue	Specification	1	55.92
Issue	Comment	1	0.154
Review	Comment	5	0

Conversation Incentives

Comment	Formatting	Relevance	Reward
Annotate them with warnings in code review to more closely scrut…	18.64 content: content: p: score: 0 elementCount: 2 h3: score: 1 elementCount: 2 h6: score: 1 elementCount: 4 ul: score: 1 elementCount: 3 li: score: 0.5 elementCount: 3 hr: score: 0 elementCount: 1 result: 10.5 regex: wordCount: 177 wordValue: 0.1 result: 8.14	1	55.92
@gentlementlegen can you fix today and leverage Whilefoo enviro…	0.77 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 11 wordValue: 0.1 result: 0.77	0.2	0.154
Resolves https://github.com/ubiquity/ts-template/issues/31Curr…	0 content: content: p: score: 0 elementCount: 3 result: 0 regex: wordCount: 67 wordValue: 0 result: 0	0.8	0
I got annotations working on the files view but I can't get the …	0 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 19 wordValue: 0 result: 0	0.4	0
Currently matches any instance of `""` but with regex ca…	0 content: content: p: score: 0 elementCount: 2 result: 0 regex: wordCount: 43 wordValue: 0 result: 0	0.7	0
It's a warning not an error. This expresses that the reviewers s…	0 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 59 wordValue: 0 result: 0	0.6	0
Also I just realized that it doesn't display annotations on GitH…	0 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 26 wordValue: 0 result: 0	0.3	0

[ 1.192 WXDAI ]
@gentlementlegen

Contributions Overview

View	Contribution	Count	Reward
Review	Comment	1	1.192

Conversation Incentives

Comment	Formatting	Relevance	Reward
@0x4007 It seems you merged this with empty strings: https://git…	1.49 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 24 wordValue: 0.1 result: 1.49	0.8	1.192

ubiquity-os · 2024-10-28T00:50:28Z

[ 156.151 WXDAI ]
@0x4007

Contributions Overview

View	Contribution	Count	Reward
Issue	Task	1	100
Issue	Specification	1	55.92
Issue	Comment	1	0.231
Review	Comment	5	0

Conversation Incentives

Comment	Formatting	Relevance	Reward
Annotate them with warnings in code review to more closely scrut…	18.64 content: content: p: score: 0 elementCount: 2 h3: score: 1 elementCount: 2 h6: score: 1 elementCount: 4 ul: score: 1 elementCount: 3 li: score: 0.5 elementCount: 3 hr: score: 0 elementCount: 1 result: 10.5 regex: wordCount: 177 wordValue: 0.1 result: 8.14	1	55.92
@gentlementlegen can you fix today and leverage Whilefoo enviro…	0.77 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 11 wordValue: 0.1 result: 0.77	0.3	0.231
Resolves https://github.com/ubiquity/ts-template/issues/31Curr…	0 content: content: p: score: 0 elementCount: 3 result: 0 regex: wordCount: 67 wordValue: 0 result: 0	0.8	0
I got annotations working on the files view but I can't get the …	0 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 19 wordValue: 0 result: 0	0.5	0
Currently matches any instance of `""` but with regex ca…	0 content: content: p: score: 0 elementCount: 2 result: 0 regex: wordCount: 43 wordValue: 0 result: 0	0.7	0
It's a warning not an error. This expresses that the reviewers s…	0 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 59 wordValue: 0 result: 0	0.6	0
Also I just realized that it doesn't display annotations on GitH…	0 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 26 wordValue: 0 result: 0	0.4	0

[ 1.192 WXDAI ]
@gentlementlegen

Contributions Overview

View	Contribution	Count	Reward
Review	Comment	1	1.192

Conversation Incentives

Comment	Formatting	Relevance	Reward
@0x4007 It seems you merged this with empty strings: https://git…	1.49 content: content: p: score: 0 elementCount: 1 result: 0 regex: wordCount: 24 wordValue: 0.1 result: 1.49	0.8	1.192

0x4007 added Time: <2 Hours Priority: 2 (Medium) labels Mar 9, 2024

ubiquibot bot added the Price: 100 USD label Mar 9, 2024

Keyrxng mentioned this issue Mar 21, 2024

feat: empty string warning #36

Closed

ubiquibot bot assigned Keyrxng Mar 25, 2024

ubiquibot bot unassigned Keyrxng Jun 4, 2024

ubiquibot bot assigned Sadaf-A Jul 5, 2024

0x4007 unassigned Sadaf-A Aug 16, 2024

devpool-directory-superintendent bot mentioned this issue Aug 29, 2024

Empty String "" Code Review Warning Annotation ubiquity/devpool-directory#1396

Closed

ubiquity-os bot assigned jordan-ae Sep 4, 2024

jordan-ae mentioned this issue Sep 10, 2024

Code review warning annotation #57

Closed

ubiquity deleted a comment from ubiquity-os bot Sep 11, 2024

ubiquity-os bot unassigned jordan-ae Sep 12, 2024

0x4007 mentioned this issue Oct 8, 2024

feat: no empty strings #62

Merged

0x4007 closed this as completed in #62 Oct 8, 2024

0x4007 mentioned this issue Oct 8, 2024

chore: empty string test #63

Closed

0x4007 reopened this Oct 8, 2024

This was referenced Oct 8, 2024

Chore/test empty string #64

Closed

Perf/ncc compiled #65

Closed

0x4007 mentioned this issue Oct 8, 2024

Chore/test empty string 2 #66

Merged

0x4007 closed this as completed in #66 Oct 9, 2024

0x4007 self-assigned this Oct 9, 2024

0x4007 reopened this Oct 9, 2024

0x4007 closed this as completed Oct 9, 2024

gentlementlegen reopened this Oct 18, 2024

gentlementlegen closed this as completed Oct 18, 2024

ubiquity deleted a comment from ubiquity-os bot Oct 18, 2024

gentlementlegen reopened this Oct 28, 2024

gentlementlegen closed this as completed Oct 28, 2024

Empty String "" Code Review Warning Annotation #31

Empty String "" Code Review Warning Annotation #31

Comments

0x4007 commented Mar 9, 2024 • edited Loading

Rationale

Examples

From codebase search: https://github.com/search?q=org%3Aubiquity+%5C%22%5C%22+language%3ATypeScript&type=code

Keyrxng commented Mar 25, 2024

ubiquibot bot commented Mar 25, 2024

Tips:

Keyrxng commented Jun 4, 2024 • edited Loading

ubiquibot bot commented Jun 4, 2024

Sadaf-A commented Jul 5, 2024

ubiquibot bot commented Jul 5, 2024

Tips:

ubiquibot bot commented Aug 16, 2024

jordan-ae commented Sep 4, 2024

ubiquity-os bot commented Sep 4, 2024

Tips:

ubiquity-os bot commented Sep 10, 2024

jordan-ae commented Sep 12, 2024

ubiquity-os bot commented Sep 12, 2024

ubiquity-os bot commented Oct 8, 2024

ubiquity-os bot commented Oct 8, 2024 • edited Loading

ubiquity-os bot commented Oct 8, 2024

ubiquity-os bot commented Oct 9, 2024

ubiquity-os bot commented Oct 9, 2024

ubiquity-os bot commented Oct 9, 2024 • edited Loading

ubiquity-os bot commented Oct 9, 2024

ubiquity-os bot commented Oct 9, 2024 • edited Loading

0x4007 commented Oct 9, 2024

ubiquity-os bot commented Oct 18, 2024 • edited Loading

Contributions Overview

Conversation Incentives

Contributions Overview

Conversation Incentives

ubiquity-os bot commented Oct 28, 2024 • edited Loading

Contributions Overview

Conversation Incentives

Contributions Overview

Conversation Incentives

Empty String `""` Code Review Warning Annotation #31

Empty String `""` Code Review Warning Annotation #31

0x4007 commented Mar 9, 2024 •

edited

Loading

Keyrxng commented Jun 4, 2024 •

edited

Loading

ubiquity-os bot commented Oct 8, 2024 •

edited

Loading

ubiquity-os bot commented Oct 9, 2024 •

edited

Loading

ubiquity-os bot commented Oct 9, 2024 •

edited

Loading

ubiquity-os bot commented Oct 18, 2024 •

edited

Loading

ubiquity-os bot commented Oct 28, 2024 •

edited

Loading