Fixed some TypeScript Lint warnings. #1390

git-init-priyanshu · 2023-09-21T15:54:25Z

What kind of change does this PR introduce?
This pull request addresses some of the TypeScript lint warnings.

Issue Number:
#1201

Fixes #1201

Did you add tests for your changes?
No. I have tested it against the existing test cases.

Snapshots/Videos:
N/A

If relevant, did you update the documentation?
No

Summary
This PR fixes the following lint warnings:

ban-ts-comment
no-explicit-any
no-inferrable-types
no-non-null-asserted-optional-chain
no-non-null-assertion
no-var-requires

Does this PR introduce a breaking change?
No

Have you read the contributing guide?
Yes

github-actions · 2023-09-21T15:55:01Z

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

The overall code coverage drops below the target threshold of the repository
Any file in the pull request has code coverage levels below the repository threshold
Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

comments in this PR or
our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

arbitrators of future discussions with other contributors about the validity of your changes
point of contact for evaluating the validity of your work
person who verifies matching issues by others that should be closed.
person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

PRs with issues not assigned to you will be closed by the reviewer
Fix the first comment in the PR so that each issue listed automatically closes

Other

🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
Read the CONTRIBUTING.md file make

github-actions

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

codecov · 2023-09-22T21:56:31Z

Codecov Report

Attention: 69 lines in your changes are missing coverage. Please review.

Comparison is base (c0468a4) 98.17% compared to head (3228758) 97.62%.
Report is 101 commits behind head on develop.

Files	Patch %	Lines
src/utilities/PII/decryption.ts	0.00%	17 Missing ⚠️
src/resolvers/middleware/currentUserExists.ts	45.83%	13 Missing ⚠️
src/utilities/PII/encryption.ts	0.00%	13 Missing ⚠️
src/utilities/PII/isAuthorised.ts	0.00%	11 Missing ⚠️
...tilities/encodedVideoStorage/uploadEncodedVideo.ts	90.12%	8 Missing ⚠️
src/resolvers/Mutation/removeAdvertisement.ts	92.85%	2 Missing ⚠️
...c/resolvers/Query/postsByOrganizationConnection.ts	33.33%	2 Missing ⚠️
src/resolvers/Subscription/onPluginUpdate.ts	0.00%	2 Missing ⚠️
src/resolvers/Query/postsByOrganization.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1390      +/-   ##
===========================================
- Coverage    98.17%   97.62%   -0.56%     
===========================================
  Files          184      214      +30     
  Lines        10767    12950    +2183     
  Branches       835     1052     +217     
===========================================
+ Hits         10571    12643    +2072     
- Misses         186      292     +106     
- Partials        10       15       +5

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

git-init-priyanshu · 2023-09-26T12:01:37Z

Hey @tasneemkoushar,
Can you please review my PR. Thanks.

git-init-priyanshu · 2023-10-03T13:52:28Z

Hey @palisadoes can you review my PR please. Thanks.

palisadoes · 2023-10-13T03:42:48Z

@tasneemkoushar Please review

palisadoes · 2023-10-13T03:43:02Z

@tasneemkoushar Please review

github-actions · 2023-10-24T00:10:25Z

This pull request did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.

palisadoes · 2023-10-27T21:41:37Z

@git-init-priyanshu Shouldn't you also be editing the .eslintrc.json file too? Ideally we should make the tests fail when the linting fails, this will help a lot with our code quality. I've added @EshaanAgg to provide his feedback.

EshaanAgg · 2023-10-28T07:55:18Z

src/resolvers/Mutation/createDirectChat.ts

@@ -48,7 +48,7 @@ export const createDirectChat: MutationResolvers["createDirectChat"] = async (
      _id: args.data.organizationId,
    }).lean();

-    await cacheOrganizations([organization!]);
+    if (organization) await cacheOrganizations([organization]);


You have added this if (organization) check in all of the caching statements to remove the use of the ! operator. Still, the same is unnecessary as it is guaranteed to exist, and thus the use of the ! operator. This change adds unnecessary verbosity to the code.
We should revert this change or find a more elegant way to deal with the same. What do you think @kb-0311?

Ok got it. I think I need to find a better way to remove the ! operator

Hey, for this can we do something like this?: we can check if we are getting id from the args and if not we can throw an error. So this will make sure that that the ids we are passing to the findOrganizationsInCache function will never be null.

EshaanAgg

Please also add all these rules to the linting config files so that husky and the workflows catch them.

palisadoes · 2023-10-30T17:34:08Z

Please fix the conflicting file

tasneemkoushar · 2023-11-03T08:18:36Z

@git-init-priyanshu can you resolve the conflicts?

noman2002 · 2023-11-11T15:43:27Z

@git-init-priyanshu Please fix the conflicting files.

git-init-priyanshu · 2023-11-11T15:59:44Z

I apologize for the inactivity. I have semester exams starting next week, so I won't have the time to work on this. Could you please grant me more time? Thank you.

tasneemkoushar · 2023-11-12T17:18:18Z

@git-init-priyanshu you can do it after your exam. FYI some linting issues have been fixed by @parthiv360 . You can check that here in this PR. Please resolve conflicting files and try to fix linting issues which aren't covered in PR #1412 once your exam finishes.

git-init-priyanshu · 2023-11-13T13:05:35Z

@git-init-priyanshu you can do it after your exam. FYI some linting issues have been fixed by @parthiv360 . You can check that here in this PR. Please resolve conflicting files and try to fix linting issues which aren't covered in PR #1412 once your exam finishes.

Yeah, sure.

noman2002 · 2023-11-16T17:37:18Z

@git-init-priyanshu Please fix the conflicting files.

tasneemkoushar · 2023-11-24T09:29:08Z

@git-init-priyanshu any update on this PR

git-init-priyanshu · 2023-11-24T14:34:37Z

@git-init-priyanshu any update on this PR

My exams just finished today, so I will be working on this now.

git-init-priyanshu · 2023-12-07T13:35:53Z

@tasneemkoushar I have made the changes. Can you check now.

EshaanAgg

Needs minor changes.

EshaanAgg · 2023-12-07T14:35:31Z

tests/utilities/imageAlreadyInDbCheck.spec.ts

@@ -190,7 +191,8 @@ describe("utilities -> imageAlreadyInDbCheck", () => {

    try {
      await imageAlreadyInDbCheck(null, testNewImagePath);
-    } catch (error: any) {
+    } catch (error: unknown) {
+      if (!(error instanceof ApplicationError)) return;


Make the test fail in such a case.

Make the test fail in such a case.

if (!(error instanceof Error)) throw new Error;

Sorry for asking but will it work?

This is not idiomatic.
Use Vitest error assertions instead.

EshaanAgg · 2023-12-07T14:35:46Z

tests/utilities/encodedImageStorage/uploadEncodedImage.spec.ts

@@ -32,7 +33,8 @@ describe("src -> utilities -> encodedImageStorage -> uploadEncodedImage", () =>
        "NAAAAKElEQVQ4jWNgYGD4Twzu6FhFFGYYNXDUwGFpIAk2E4dHDRw1cDgaCAASFOffhEIO" +
        "3gAAAABJRU5ErkJggg==";
      await uploadEncodedImage(img, null);
-    } catch (error: any) {
+    } catch (error: unknown) {
+      if (!(error instanceof ApplicationError)) return;


Make the test fail here instead of returning.

EshaanAgg · 2023-12-07T14:35:57Z

tests/utilities/adminCheck.spec.ts

@@ -50,7 +50,8 @@ describe("utilities -> adminCheck", () => {
        testUser?._id,
        testOrganization ?? ({} as InterfaceOrganization)
      );
-    } catch (error: any) {
+    } catch (error: unknown) {
+      if (!(error instanceof Error)) return;


git-init-priyanshu · 2023-12-09T09:20:55Z

Hey @EshaanAgg can you please check now.

EshaanAgg · 2023-12-09T10:58:20Z

Please fix the failing workflows.

git-init-priyanshu · 2023-12-14T15:21:15Z

Please fix the failing workflows.

can you check now

…a-api-clone into git-init-priyanshu

EshaanAgg · 2023-12-17T20:12:53Z

@git-init-priyanshu The tests are still failing.

…a-api-clone into git-init-priyanshu

EshaanAgg

The PR has the right spirit but needs work. Instead of trying to fix the lining warnings, please try to understand the intent behind using ! or ? and then write the resolvers accordingly. TypeScript and lining rules should help to enforce these patterns, not bother.

EshaanAgg · 2023-12-18T18:13:26Z

src/resolvers/Mutation/createPost.ts

@@ -150,7 +150,7 @@ export const createPost: MutationResolvers["createPost"] = async (
      }
    );

-    await cacheOrganizations([updatedOrganizaiton!]);
+    if (updatedOrganizaiton) await cacheOrganizations([updatedOrganizaiton]);


In all such cases we are assured that the updatedOrganization would be not null due to the business logic. Thus this conditional is useless.

EshaanAgg · 2023-12-18T18:13:32Z

src/resolvers/Mutation/createPost.ts

@@ -55,7 +55,7 @@ export const createPost: MutationResolvers["createPost"] = async (
      _id: args.data.organizationId,
    }).lean();

-    await cacheOrganizations([organization!]);
+    if (organization !== null) await cacheOrganizations([organization]);


EshaanAgg · 2023-12-18T18:14:08Z

src/resolvers/Mutation/removeMember.ts

@@ -42,7 +42,7 @@ export const removeMember: MutationResolvers["removeMember"] = async (
      _id: args.data.organizationId,
    }).lean();

-    await cacheOrganizations([organization!]);
+    if (organization !== null) await cacheOrganizations([organization]);


EshaanAgg · 2023-12-18T18:14:19Z

src/resolvers/Mutation/updateUserProfile.ts

-  updatedUser!.image = updatedUser?.image
-    ? `${context.apiRootUrl}${updatedUser?.image}`
-    : null;
+  if (updatedUser)


…a-api-clone into git-init-priyanshu

palisadoes · 2023-12-25T13:41:48Z

@git-init-priyanshu

You have made almost 40 commits to this PR without closing it.
Something is wrong with your methodology or the original issue needs to be adjusted. We have a linting issue created to just check on the deltas which may be more appropriate.
- Apply Linting Only to Files Updated in git #1548

Please close this PR and the issue if the issue above is a more suitable solution.

git-init-priyanshu · 2023-12-25T14:06:14Z

I totally agree with you, sir. I was also losing motivation to work on this PR. I will review my methodology and make sure to work on this. If you have any specific suggestions or insights, I would welcome them to ensure that I can improve.

palisadoes · 2023-12-25T14:21:11Z

Thanks. I'll close this and the issue too.
Focus on other issues that will reactivate your motivation.

Fixed some lint warnings

62253ff

github-actions bot reviewed Sep 21, 2023

View reviewed changes

palisadoes requested a review from tasneemkoushar September 22, 2023 21:56

palisadoes closed this Oct 13, 2023

palisadoes reopened this Oct 13, 2023

github-actions bot added the no-pr-activity No pull request activity label Oct 24, 2023

palisadoes requested review from anwersayeed and EshaanAgg October 27, 2023 21:38

github-actions bot removed the no-pr-activity No pull request activity label Oct 28, 2023

EshaanAgg reviewed Oct 28, 2023

View reviewed changes

EshaanAgg requested changes Oct 28, 2023

View reviewed changes

noman2002 requested a review from EshaanAgg November 11, 2023 15:43

Merge branch 'develop' into git-init-priyanshu

0d6a7e9

Removed unnecessary verbosity to the code.

160b323

EshaanAgg requested changes Dec 7, 2023

View reviewed changes

Improved test file error handling and removed redundant code.

ee02dc9

Merge branch 'PalisadoesFoundation:develop' into git-init-priyanshu

d67914b

palisadoes requested a review from EshaanAgg December 15, 2023 05:40

git-init-priyanshu added 2 commits December 16, 2023 12:36

Merge branch 'develop' of https://github.com/git-init-priyanshu/talaw…

23a949d

…a-api-clone into git-init-priyanshu

Fixing failing tests

78e2924

git-init-priyanshu added 2 commits December 18, 2023 11:08

Formatting fix

a4fdf22

Merge branch 'develop' of https://github.com/git-init-priyanshu/talaw…

7b18bd7

…a-api-clone into git-init-priyanshu

EshaanAgg requested changes Dec 18, 2023

View reviewed changes

git-init-priyanshu and others added 6 commits December 19, 2023 12:46

100% code coverage of createPost.ts

878bb5d

Merge branch 'develop' of https://github.com/git-init-priyanshu/talaw…

a680b4b

…a-api-clone into git-init-priyanshu

Merge branch 'PalisadoesFoundation:develop' into git-init-priyanshu

5e15bb7

Improved code coverage of updateUserProfile.ts

e9b2b22

Fixing failing tests.

5d34846

Fixing failing tests.

3228758

palisadoes closed this Dec 25, 2023

shankeleven mentioned this pull request Jan 30, 2024

Added server health check to github workflow #1717

Merged

Fixed some TypeScript Lint warnings. #1390

Fixed some TypeScript Lint warnings. #1390

Conversation

git-init-priyanshu commented Sep 21, 2023

github-actions bot commented Sep 21, 2023

Our Pull Request Approval Process

Testing Your Code

Reviewers

Reviewing Your Code

CONTRIBUTING.md

Other

github-actions bot left a comment

Choose a reason for hiding this comment

codecov bot commented Sep 22, 2023 • edited Loading

Codecov Report

git-init-priyanshu commented Sep 26, 2023

git-init-priyanshu commented Oct 3, 2023

palisadoes commented Oct 13, 2023

palisadoes commented Oct 13, 2023

github-actions bot commented Oct 24, 2023

palisadoes commented Oct 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

EshaanAgg left a comment • edited Loading

Choose a reason for hiding this comment

palisadoes commented Oct 30, 2023

tasneemkoushar commented Nov 3, 2023

noman2002 commented Nov 11, 2023

git-init-priyanshu commented Nov 11, 2023

tasneemkoushar commented Nov 12, 2023

git-init-priyanshu commented Nov 13, 2023

noman2002 commented Nov 16, 2023

tasneemkoushar commented Nov 24, 2023

git-init-priyanshu commented Nov 24, 2023

git-init-priyanshu commented Dec 7, 2023

EshaanAgg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

git-init-priyanshu commented Dec 9, 2023 • edited Loading

EshaanAgg commented Dec 9, 2023

git-init-priyanshu commented Dec 14, 2023 • edited Loading

EshaanAgg commented Dec 17, 2023

EshaanAgg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

palisadoes commented Dec 25, 2023

git-init-priyanshu commented Dec 25, 2023

palisadoes commented Dec 25, 2023

codecov bot commented Sep 22, 2023 •

edited

Loading

EshaanAgg left a comment •

edited

Loading

git-init-priyanshu commented Dec 9, 2023 •

edited

Loading

git-init-priyanshu commented Dec 14, 2023 •

edited

Loading