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.

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

Bug 1891121 - Add experiment brief links to experiment and rollout tables #524

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

sarahhjchung
Copy link
Collaborator

@sarahhjchung sarahhjchung commented Dec 18, 2024

Bug 1891121

Changes made:

  • RecipeInfo now includes an experimentBriefLink property with the url to experiment link Google docs
  • A tooltip button of the FileText icon from lucide-icons is now displayed next to the experiment/rollout name if an experiment brief link exists
  • The package @mozilla/nimbus-schemas has been imported and replaces the NimbusExperiment type used from @mozilla/nimbus-shared

Copy link

netlify bot commented Dec 18, 2024

Deploy Preview for fxms-skylight ready!

Name Link
🔨 Latest commit 4b82d02
🔍 Latest deploy log https://app.netlify.com/sites/fxms-skylight/deploys/67e30034edbffb00086990c5
😎 Deploy Preview https://deploy-preview-524--fxms-skylight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 98 (🟢 up 3 from production)
Accessibility: 88 (🔴 down 1 from production)
Best Practices: 92 (🟢 up 9 from production)
SEO: 100 (🟢 up 10 from production)
PWA: -
View the detailed breakdown and full score reports

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

@sarahhjchung
Copy link
Collaborator Author

DocumentationLinks were exposed in the experimenter v7 api and I am able to get the data from it. However, I'm getting build failures due to documentationLinks not being defined in the node_modules/@mozilla/nimbus-shared/types/experiments.ts file. Is this file something that needs to be updated by us or something we need to request the nimbus team for?

@dmose
Copy link
Member

dmose commented Dec 19, 2024

We need to request that the experimenter team do it (or put in a PR ourselves and ask for their review).

@sarahhjchung sarahhjchung requested a review from dmose March 21, 2025 17:10
Copy link
Member

@dmose dmose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking good! A couple of UX things that I think we want to tweak though:

image

  1. In all of them, I think the experiment slug wants to be indented to start in the same place as the human-readable experiment name, as it's visually a bit confusing as-is. That said, that would line the experiment info up with the branch info, so maybe we'd want to indent the branches more too. Play around a bit and see what looks reasonable.
  2. In the Mozilla VPN one, if it's easy to prevent wrapping (eg with  ) a line-break just before the symbol, I think the visual presentation would be smoother.

app/columns.tsx Outdated
Comment on lines 419 to 431
<svg
fill="currentColor"
fillOpacity="0.6"
viewBox="0 0 8 8"
className="inline h-[1.2rem] w-[1.2rem] px-1"
aria-hidden="true"
style={{
marginInline: "0.1rem 0",
paddingBlock: "0 0.1rem",
overflow: "visible",
}}
>
<path d="m1.71278 0h.57093c.31531 0 .57092.255837.57092.571429 0 .315591-.25561.571431-.57092.571431h-.57093c-.31531 0-.57093.25583-.57093.57143v4.57142c0 .3156.25562.57143.57093.57143h4.56741c.31531 0 .57093-.25583.57093-.57143v-.57142c0-.3156.25561-.57143.57092-.57143.31532 0 .57093.25583.57093.57143v.57142c0 .94678-.76684 1.71429-1.71278 1.71429h-4.56741c-.945943 0-1.71278-.76751-1.71278-1.71429v-4.57142c0-.946778.766837-1.71429 1.71278-1.71429zm5.71629 0c.23083.0002686.43879.13963.52697.353143.02881.069172.04375.143342.04396.218286v2.857141c0 .31559-.25561.57143-.57093.57143-.31531 0-.57092-.25584-.57092-.57143v-1.47771l-1.88006 1.88171c-.14335.14855-.35562.20812-.55523.15583-.19962-.0523-.35551-.20832-.40775-.40811-.05225-.19979.00727-.41225.15569-.55572l1.88006-1.88171h-1.47642c-.31531 0-.57093-.25584-.57093-.571431 0-.315592.25562-.571429.57093-.571429z"></path>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add an XXX comment both here and later in the file that we should switch to the Lucide Icon for an external link instead of maintaining our own? (I don't think we need to fix this now).

package.json Outdated
@@ -19,6 +19,7 @@
"dependencies": {
"@auth0/nextjs-auth0": "^3.6.0",
"@looker/sdk-node": "25.4.0",
"@mozilla/nimbus-schemas": "^3001.0.0",
"@mozilla/nimbus-shared": "^2.5.2",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From reading https://github.com/mozilla/nimbus-shared, it sounds like we don't need nimbus-shared any more.

const nimbusExperimentV7Schema = require("@mozilla/nimbus-schemas/schemas/NimbusExperimentV7.schema.json");
type NimbusExperiment = typeof nimbusExperimentV7Schema.properties;
type DocumentationLink =
typeof nimbusExperimentV7Schema.properties.documentationLinks;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be helpful to put JSDoc comments here explaining why you're doing the type aliasing.

@sarahhjchung
Copy link
Collaborator Author

I played around with the spacing and indenting and concluded on this.

Screenshot 2025-03-24 at 4 39 39 PM

I've made the user facing name experiment/rollout (ie. the bold text) to have the overflow-visible property to prevent weird wrapping with the external link icon because I couldn't figure out exactly how to work &nbsp; to my advantage. Let me know if the UI tweaks look good and I'm always welcome to more feedback!

@sarahhjchung sarahhjchung requested a review from dmose March 24, 2025 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants