Dominick/639 feat: add user account link to sidebar by HoldUpFjord · Pull Request #651 · LetsGetTechnical/gridiron-survivor

HoldUpFjord · 2024-11-04T19:41:27Z

Added a link to navbar for the account/profile route.

Component view:

Page View

appwrite · 2024-11-04T19:41:30Z

Gridiron Survivor Application 6616ea581ef9f5521c7d

Function	ID	Status	Action
Your function has been successfully deployed.

Project name: Gridiron Survivor Application
Project ID: 6616ea581ef9f5521c7d

Function	ID	Status	Action
userAuth	`6626fef885a9f630442b`	Ready	View Logs

Only deployments on the production branch are activated automatically. If you'd like to activate this deployment, navigate to your deployments. Learn more about Appwrite Function deployments.

💡 Did you know?
You can use Avatars API to generate QR code for any text or URLs

vercel · 2024-11-04T19:41:31Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
gridiron-survivor	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 20, 2024 8:06pm
gridiron-survivor-storybook	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 20, 2024 8:06pm

mhchen

If you're feeling bold I think you should refactor this into a NavLink component, since all 3 navlinks are pretty much identical except for the href/testid

braydoncoyer · 2024-11-05T01:18:58Z

Do we want any tests for this change? I see a data-testid added but no associated test.

HoldUpFjord · 2024-11-05T15:45:46Z

@mhchen I think that makes a lot of sense. I'm feeling up to it. Just to clarify, this navlink refactor would be a part of this PR as opposed to making another ticket/pr for the refactor at a later time?

@braydoncoyer That's another question I had! The other links have tests written for them in the nav.test file. I wasn't sure if it would be out of scope to add a test for this or not. My opinion is it can't hurt to add it, and there's already a reference I can work off of. It seems like a easy pickup.

shashilo · 2024-11-09T18:20:50Z

@mhchen I think that makes a lot of sense. I'm feeling up to it. Just to clarify, this navlink refactor would be a part of this PR as opposed to making another ticket/pr for the refactor at a later time?

@braydoncoyer That's another question I had! The other links have tests written for them in the nav.test file. I wasn't sure if it would be out of scope to add a test for this or not. My opinion is it can't hurt to add it, and there's already a reference I can work off of. It seems like a easy pickup.

If you touch it, you test it.

shashilo · 2024-11-09T18:22:12Z

@mhchen I think that makes a lot of sense. I'm feeling up to it. Just to clarify, this navlink refactor would be a part of this PR as opposed to making another ticket/pr for the refactor at a later time?

@braydoncoyer That's another question I had! The other links have tests written for them in the nav.test file. I wasn't sure if it would be out of scope to add a test for this or not. My opinion is it can't hurt to add it, and there's already a reference I can work off of. It seems like a easy pickup.

When you come acrosss items that are repetitive, you should always look into componetizing them. It's easier to maintain and the code is only in 1 place.

HoldUpFjord · 2024-11-11T19:20:05Z

@mhchen I think that makes a lot of sense. I'm feeling up to it. Just to clarify, this navlink refactor would be a part of this PR as opposed to making another ticket/pr for the refactor at a later time?
@braydoncoyer That's another question I had! The other links have tests written for them in the nav.test file. I wasn't sure if it would be out of scope to add a test for this or not. My opinion is it can't hurt to add it, and there's already a reference I can work off of. It seems like a easy pickup.

When you come acrosss items that are repetitive, you should always look into componetizing them. It's easier to maintain and the code is only in 1 place.

Great, thanks for the clarification. I'll get right on it!

…o-sidebar

Danielle254 · 2024-11-13T21:07:52Z

Why was this file changed?

Because I'm not the brightest tool in the shed.

It's a mistake that's since been reverted.

…kage-lock.json This reverts commit 800457d.

kepsteen

LGTM

braydoncoyer

LGTM! ✅

shashilo · 2024-11-18T20:55:36Z

 import { Menu } from 'lucide-react';
 import { Button } from '../Button/Button';
-import Link from 'next/link';
+import NavLink from '../NavLink/NavLink'; // Adjust the import path as necessary


remove comment

shashilo · 2024-11-18T20:56:30Z

+   * Handles closing the drawer.
+   * @returns {void} No return value.
+   */
+  const handleClose = (): void => setOpen(false);


Why do we need a variable to call this useState directly?

I was getting the following error if I didn't declare the useState directly:

Would you prefer this bit implemented differently?

shashilo · 2024-11-18T20:57:51Z

-                    Leagues
-                  </Link>
-                </li>
+                <NavLink


Nicely done!

shashilo · 2024-11-18T20:58:14Z

+  href: string;
+  testId: string;
+  children: React.ReactNode;
+  onClose?: () => void;


Why is onClose optional?

I may be misunderstanding, but my line of thought was it needed to be optional because onClose it's a function that's toggled on click. The nature of the toggle indicating that the onClose function is always 'provided'/there.

shashilo · 2024-11-18T20:58:34Z

+
+/**
+ * Renders a navigation link.
+ * @param {NavLinkProps} props - The properties for the navigation link.


nit: Call out all the props

Something like this format? This example doesn't handle other nits.

/** * Renders a navigation link. * @param {string} props.href - The URL the link points to. * @param {string} props.testId - The test ID for the link. * @param {React.ReactNode} props.children - The content to be rendered inside the link. * @param {Function} [props.onClose] - Optional function to be called when the link is clicked. * @returns {JSX.Element} The rendered navigation link. */

shashilo · 2024-11-18T20:58:51Z

+        className={cn(
+          'underline underline-offset-4 hover:text-primary-muted transition-colors',
+        )}
+        onClick={onClose}


If this was optional, this code should fail.

Oh that's true. If it was optional, would the better way of handling it defining a variable that states its conditional and then testing that? Something like:"

const NavLink = ({ href, testId, children, onClose, }: NavLinkProps): JSX.Element => { const handleClick = () => { if (onClose) { onClose(); } }; return ( <a href={href} data-testid={testId} onClick={handleClick}> {children} </a> ); };

shashilo · 2024-11-18T20:59:43Z

@@ -69,28 +75,27 @@ export const Nav = (): JSX.Element => {
                <DrawerTitle data-testid="title">Gridiron Survivor</DrawerTitle>
              </DrawerHeader>
              <ul className="m-0 flex flex-col gap-1 p-0">


nit: could go as far as making this NavLinkContainer component.

I don't quite understand what you mean here. Are you thinking NavLinkContainer would be a new component leveraging the <Drawer/> component?

shashilo · 2024-11-18T20:59:58Z

+// Copyright (c) Gridiron Survivor.
+// Licensed under the MIT License.
+
+import React, { JSX } from 'react';


Need a unit test for this new component.

Ah so I should take the relevant tests form the original nav.tsx and move them into a new NavList.test file? That makes sense.

No. You should create a brand new NavLink unit test file. It should ensure that all the props that can change will change correctly.

@shashilo Latest changes address this i think

shashilo · 2024-11-19T20:31:50Z

+// Copyright (c) Gridiron Survivor.
+// Licensed under the MIT License.
+
+import React, { JSX } from 'react';


No. You should create a brand new NavLink unit test file. It should ensure that all the props that can change will change correctly.

…o-sidebar

…ttps://github.com/LetsGetTechnical/gridiron-survivor into dominick/639-feat-add-user-account-link-to-sidebar

HoldUpFjord added 3 commits November 4, 2024 14:21

created link iink in navbar that goes to /account/profile

5474bf6

got rid of comments

641610e

Altered copy to be one word

80eee47

HoldUpFjord added the Functional Engineering label Nov 4, 2024

HoldUpFjord requested review from mhchen and shashilo as code owners November 4, 2024 19:41

mhchen previously approved these changes Nov 4, 2024

View reviewed changes

HoldUpFjord added 3 commits November 13, 2024 14:05

created navlink component

5ecc1b0

refactored links to be navLinks

634d468

added test for new /profile route

24d3425

HoldUpFjord dismissed mhchen’s stale review via 24d3425 November 13, 2024 19:06

vercel Bot deployed to Preview – gridiron-survivor-storybook November 13, 2024 19:07 View deployment

Merge branch 'develop' into dominick/639-feat-add-user-account-link-t…

af5c6b1

…o-sidebar

vercel Bot had a problem deploying to Preview – gridiron-survivor November 13, 2024 19:08 Failure

vercel Bot deployed to Preview – gridiron-survivor-storybook November 13, 2024 19:11 View deployment

vercel Bot had a problem deploying to Preview – gridiron-survivor November 13, 2024 19:11 Failure

changes to pass build step/ linter

800457d

vercel Bot had a problem deploying to Preview – gridiron-survivor-storybook November 13, 2024 19:42 Failure

vercel Bot deployed to Preview – gridiron-survivor November 13, 2024 19:44 View deployment

Danielle254 reviewed Nov 14, 2024

View reviewed changes

Revert "changes to pass build step/ linter", namelyt altering the pac…

51151ad

…kage-lock.json This reverts commit 800457d.

vercel Bot deployed to Preview – gridiron-survivor-storybook November 14, 2024 15:41 View deployment

vercel Bot had a problem deploying to Preview – gridiron-survivor November 14, 2024 15:41 Failure

kepsteen previously approved these changes Nov 14, 2024

View reviewed changes

Comment thread components/Nav/Nav.tsx Outdated

testing local dev fix by reverting alias changes.

0423909

HoldUpFjord dismissed kepsteen’s stale review via 0423909 November 15, 2024 17:57

vercel Bot deployed to Preview – gridiron-survivor-storybook November 15, 2024 17:58 View deployment

vercel Bot deployed to Preview – gridiron-survivor November 15, 2024 17:59 View deployment

fixes jsdoc break in cody nit

15b023f

vercel Bot deployed to Preview – gridiron-survivor-storybook November 15, 2024 18:14 View deployment

restores break after imports

1065a79

vercel Bot deployed to Preview – gridiron-survivor-storybook November 15, 2024 18:16 View deployment

vercel Bot deployed to Preview – gridiron-survivor November 15, 2024 18:17 View deployment

kepsteen previously approved these changes Nov 16, 2024

View reviewed changes

braydoncoyer approved these changes Nov 17, 2024

View reviewed changes

shashilo requested changes Nov 18, 2024

View reviewed changes

fix: remove comment to resolve Shashi PR conversation.

bc7b68c

HoldUpFjord dismissed kepsteen’s stale review via bc7b68c November 19, 2024 19:00

vercel Bot deployed to Preview – gridiron-survivor November 19, 2024 19:01 View deployment

vercel Bot deployed to Preview – gridiron-survivor-storybook November 19, 2024 19:02 View deployment

shashilo requested changes Nov 19, 2024

View reviewed changes

Merge branch 'develop' into dominick/639-feat-add-user-account-link-t…

d855689

…o-sidebar

vercel Bot deployed to Preview – gridiron-survivor-storybook November 19, 2024 20:34 View deployment

vercel Bot deployed to Preview – gridiron-survivor November 19, 2024 20:35 View deployment

HoldUpFjord added 3 commits November 19, 2024 15:57

Merge branch 'develop' into dominick/639-feat-add-user-account-link-t…

3f43c62

…o-sidebar

fix/ addresses pr review to expand JSdocs to cover props

2dbfc34

Merge branch 'dominick/639-feat-add-user-account-link-to-sidebar' of h…

177f43c

…ttps://github.com/LetsGetTechnical/gridiron-survivor into dominick/639-feat-add-user-account-link-to-sidebar

vercel Bot deployed to Preview – gridiron-survivor November 19, 2024 21:14 View deployment

added new navlink file

fa1f00b

vercel Bot deployed to Preview – gridiron-survivor-storybook November 19, 2024 21:15 View deployment

fix: addresses new to test for props in NavLink componenet

61a2961

vercel Bot deployed to Preview – gridiron-survivor November 20, 2024 20:05 View deployment

vercel Bot deployed to Preview – gridiron-survivor-storybook November 20, 2024 20:06 View deployment

Conversation

HoldUpFjord commented Nov 4, 2024

Added a link to navbar for the account/profile route.

Uh oh!

appwrite Bot commented Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel Bot commented Nov 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mhchen left a comment

Choose a reason for hiding this comment

Uh oh!

braydoncoyer commented Nov 5, 2024

Uh oh!

HoldUpFjord commented Nov 5, 2024

Uh oh!

shashilo commented Nov 9, 2024

Uh oh!

shashilo commented Nov 9, 2024

Uh oh!

HoldUpFjord commented Nov 11, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kepsteen left a comment

Choose a reason for hiding this comment

Uh oh!

braydoncoyer left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

appwrite Bot commented Nov 4, 2024 •

edited

Loading

vercel Bot commented Nov 4, 2024 •

edited

Loading