') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ', 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); })(); fix(shared): Remove testUtils & smaller updates by LekoArts · Pull Request #1868 · clerk/javascript · GitHub
Skip to content

fix(shared): Remove testUtils & smaller updates - #1868

Merged
LekoArts merged 7 commits into
mainfrom
cleanup/shared-test-utils
Oct 12, 2023
Merged

fix(shared): Remove testUtils & smaller updates#1868
LekoArts merged 7 commits into
mainfrom
cleanup/shared-test-utils

Conversation

@LekoArts

@LekoArtsLekoArts commented Oct 12, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

Description

While working on JS-509 I quickly realized that putting that into one big PR would be a mess. So this is a slice of work that can be shipped separately and removes some noise from the original purpose of that ticket.

This PR does a couple of things:

  • Remove testUtils from @clerk/shared. There's no need to put this into such a package, it can live inside the repo outside of a npm package. The contents of the testUtils were re-exports from @testing-library/react and an unused wrapper. So I didn't have to move it somewhere else, I just had to update the imports
  • Fix the Jest config @clerk/shared. Through an incorrect testRegex one test was never run. Jest's defaults are fine for our use case, so we don't even need to set it
  • Remove the package.json we put into dist/cjs and dist/esm. They have no benefit since the root package.json already has sideEffects defined.
  • Add peerDependenciesMeta to make react peerDep optional
  • Use correct LICENSE
  • Add author

Checklist

  • npm test runs as expected.
  • npm run build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Packages affected

  • @clerk/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore

@changeset-bot

changeset-botBot commented Oct 12, 2023•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: b5955bb

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 11 packages
NameType
@clerk/sharedPatch
@clerk/backendPatch
@clerk/clerk-jsPatch
@clerk/clerk-expoPatch
@clerk/fastifyPatch
@clerk/nextjsPatch
@clerk/clerk-reactPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch
gatsby-plugin-clerkPatch
@clerk/chrome-extensionPatch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

LekoArts
LekoArts commented Oct 12, 2023
View reviewed changes
Comment threadpackages/clerk-js/src/utils/__tests__/ignoreEventValue.test.ts
LekoArts
LekoArts commented Oct 12, 2023
View reviewed changes
Comment threadpackages/shared/src/testUtils/testUtils.ts

@LekoArtsLekoArtsOct 12, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

These were just all re-exports that did nothing

LekoArts
LekoArts commented Oct 12, 2023
View reviewed changes
Comment threadpackages/clerk-js/setupJestAfterEnv.ts
@@ -1,11 +1 @@
import '@testing-library/jest-dom';

@LekoArtsLekoArtsOct 12, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

We had @testing-library/jest-dom/extend-expect in our testUtils file. This line already covers this

@LekoArts
LekoArts marked this pull request as ready for review October 12, 2023 09:38
@LekoArts
LekoArts requested a review from a team as a code ownerOctober 12, 2023 09:38
dimkl
dimkl approved these changes Oct 12, 2023
View reviewed changes
Comment thread.changeset/serious-meals-wink.md
@@ -0,0 +1,9 @@
---
"@clerk/shared": patch

@dimkldimklOct 12, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🔧 I think that changing the public API (eg removing an export in our case) of a package requires a major version bump.

@LekoArtsLekoArtsOct 12, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

It's an internal package without a README only used by our Jest tests that we also don't tell people to install or use. It'd consider it purely internal.

So while technically you're correct, I wouldn't care about that :)

Comment threadpackages/clerk-js/src/utils/__tests__/ignoreEventValue.test.ts
@LekoArts
LekoArts added this pull request to the merge queue Oct 12, 2023
Merged via the queue into main with commit 834dadbOct 12, 2023
@LekoArts
LekoArts deleted the cleanup/shared-test-utils branch October 12, 2023 14:43
@clerk-cookieclerk-cookie mentioned this pull request Oct 12, 2023
Merged
This was referenced Oct 17, 2023
Closed
Merged
nikosdouvlis
nikosdouvlis reviewed Oct 18, 2023
View reviewed changes

@nikosdouvlisnikosdouvlis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Awesome job @LekoArts 🔥

Remove the package.json we put into dist/cjs and dist/esm. They have no benefit since the root package.json already has sideEffects defined.

For future reference, old Vite React apps weren't picking up the root package.json's sideEffects prop. It seems that this has been fixed since then so all changes in this PR as spot on.

@clerk-cookie

clerk-cookie commented Oct 18, 2024

Copy link
Copy Markdown
Collaborator

This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@clerkclerk locked as resolved and limited conversation to collaborators Oct 18, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@nikosdouvlisnikosdouvlisnikosdouvlis approved these changes
@brkalowbrkalowbrkalow approved these changes
+1 more reviewer
@dimkldimkldimkl approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

clerk-jsreact

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@LekoArts@clerk-cookie@brkalow@nikosdouvlis@dimkl