JetpackFooter: add About, Privacy and Terms links #31627

monsieur-z · 2023-06-28T20:52:19Z

Proposed changes:

The JetpackFooter component is used in the Jetpack flagship plugin and many other Jetpack plugins. In the former, it contains links to about, TOS, and privacy pages that are not included in the latter, though they can provide value in those instances as well. This PR integrates the About, Terms, and Privacy links into the JetpackFooter component directly.

It also removes from the props the URL to which the Automattic logo links to since all instances using JetpackFooter would pass the same URL.

In more detail:

it makes the About, Terms, and Privacy links part of JetpackFooter
it passes click handlers to these links as props of JetpackFooter
it removes the prop a8cLogoHref from JetpackFooter
when applicable, it links the Privacy and An Automattic Airline links to internal pages
makes the Jetpack logo on the My Jetpack footer match the size of the same logo in other sections

Other information:

Have you written new tests for your changes, if applicable?
Have you checked the E2E test CI results, and verified that your changes do not break them?
Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

p1687876101340969-slack-C01264051NE
p1687874518864269-slack-C02TQF5VAJD

Does this pull request change what data or activity we track or use?

No.

Testing instructions:

Spin up a test site with this branch
Make sure your site is not connected to Jetpack
Visit the Jetpack section
In the footer, check the following links:
- Jetpack: https://jetpack.com/
- About: https://jetpack.com/about/
- Privacy: https://automattic.com/privacy/
- Terms: https://wordpress.com/tos/
- An Automattic Airline: https://automattic.com/about/
Visit the My Jetpack section
- In the footer, check the following links:
- Jetpack: https://jetpack.com/
- About: https://jetpack.com/about/
- Privacy: https://automattic.com/privacy/
- Terms: https://wordpress.com/tos/
- An Automattic Airline: https://automattic.com/about/
Connect your site to Jetpack
In the footer, check the following links:
- Jetpack: https://jetpack.com/
- About: https://jetpack.com/about/
- Privacy: /wp-admin/admin.php?page=jetpack#/privacy
- Terms: https://wordpress.com/tos/
- An Automattic Airline: /wp-admin/admin.php?page=jetpack_about

github-actions · 2023-06-28T20:53:38Z

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

✅ Include a description of your PR changes.
⚠️ All commits were linted before commit.
✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
✅ Add testing instructions.
✅ Specify whether this PR includes any changes to data or privacy.
✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Once your PR is ready for review, check one last time that all required checks (other than "Required review") appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

Next scheduled release: August 1, 2023.
Scheduled code freeze: July 25, 2023.

Social plugin:

Next scheduled release: August 1, 2023.
Scheduled code freeze: July 25, 2023.

github-actions · 2023-06-28T20:53:39Z

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta > Jetpack and enable the add/jetpack-footer-generic-links branch.

To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack add/jetpack-footer-generic-links

bin/jetpack-downloader test jetpack-mu-wpcom-plugin add/jetpack-footer-generic-links

Interested in more tips and information?

In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
Read more about our development workflow here: PCYsg-eg0-p2
Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

monsieur-z · 2023-06-29T14:37:08Z

projects/js-packages/components/components/admin-page/index.tsx

-							a8cLogoHref={ a8cLogoHref }
-							moduleNameHref={ moduleNameHref }
-						/>
+						<JetpackFooter moduleName={ moduleName } moduleNameHref={ moduleNameHref } />


href of the Automattic logo is set in JetpackFooter directly.

monsieur-z · 2023-07-03T15:09:27Z

projects/js-packages/components/components/jetpack-footer/index.tsx

 import { Icon, external } from '@wordpress/icons';
 import classnames from 'classnames';
 import React from 'react';
+import { getRedirectUrl } from '../..';
+import { STORE_ID as CONNECTION_STORE_ID } from '../../../../js-packages/connection/state/store';


Importing from @automattic/jetpack-connection directly made the build fail because of some circular dependency. This import seems fine, but let me know if there's a better approach. Hardcoding the store id seemed error-prone.

I wonder if this may prove problematic in the version of the package that we ship to npm.

Couldn't we bring in that data as a new component prop, to keep the component a bit simpler?

Hardcoding the store id seemed error-prone.

That'd be my next suggestion, with a comment in the original file mentioning that it's copied there, but I'm not a regular component maintainer so I'll let others weigh in on this. :)

Now that the connection package js is loaded externally and not bundled into any plugin after #38877, this import here can be problematic and result in duplicate store registration.

We should fix this in a better way. A few options we have:

Let the consumer component pass the needed connection related information

Make the component composable, which means the consumer component passes in the final output without this component here knowing anything about the connection data

Another solution would be to use the data from the scrip-data package as explained in this thread.

That said, composability is still better because that will not make the component dependent upon anything related to jetpack connection or its logic.

monsieur-z · 2023-07-03T15:16:39Z

projects/js-packages/components/components/jetpack-footer/index.tsx

+	);
+
+	const areAdminLinksEnabled =
+		siteAdminUrl &&


Ideally, siteAdminUrl would be retrieved from an initial state, as is connectedPlugins. I haven't found a way of retrieving basic site information that works across packages yet.

We now have getAdminUrl and other such utils available in @automattic/jetpack-script-data

import { getAdminUrl, getJetpackAdminPageUrl } from '@automattic/jetpack-script-data'; const aboutPageUrl = getAdminUrl( 'admin.php?page=jetpack_about' ); const privacyPageUrl = getJetpackAdminPageUrl( '#/privacy' );

Likewise, you can use the same package to get the list of connected plugins and the status.

import { getScriptData } from '@automattic/jetpack-script-data'; const { connectedPlugins, connectionStatus } = getScriptData().connection;

andrii-lysenko · 2023-07-10T17:37:27Z

@jeherve the about link should be fixed now. As per STORE_ID import I don't see a problem there, and passing it as a parameter also might be not ideal as one of the renders of JetpackFooter is from AdminPage which is also in same package. We would then need to pass it through additional component. However, I'm also not an expert in components and may be there's some other ways.

bindlegirl · 2023-07-14T10:35:20Z

The logged-in About link on the Jetpack dashboard (and other) pages shows up as an external link, although it's not. However, it loads the About page in a new tab, which differs from the Terms and Airline pages.

There are inconsistencies between the MyJetpack footer and other pages. This is what I see:

Logged out About link on the Jetpack page will load https://jetpack.com/about/?site=nutritious-fairy.jurassic.ninja and MyJetpack https://jetpack.com/about
Logged in About link on the Jetpack page will load /wp-admin/admin.php?page=jetpack_about and MyJetpack will load https://jetpack.com/about/

Privacy on connected MyJetpack is still an external link.

I'm unsure if aligning these should be a part of another PR.

kraftbj · 2023-07-19T18:13:51Z

I'm unsure if aligning these should be a part of another PR.

Yeah, let's land this and open an issue to track the variations.

andrii-lysenko · 2023-07-19T18:14:44Z

@bindlegirl I think the idea of shipping as is, but, creating a follow up issue sounds as a good idea to me.
@jeherve do you want to take a second look?

…eneric-links

bindlegirl · 2023-07-19T18:56:23Z

Sounds good to me 👍
Other than noted details, the PR looks good

…etpack-footer-generic-links

monsieur-z force-pushed the add/jetpack-footer-generic-links branch from a2107bf to 92bf77b Compare June 29, 2023 13:17

monsieur-z changed the title ~~Add/jetpack footer generic links~~ JetpackFooter: add About, Privacy and Terms links Jun 29, 2023

github-actions bot added [Package] Ad aka WordAds [Package] Search Contains core Search functionality for Jetpack and Search plugins Docs labels Jun 29, 2023

monsieur-z commented Jun 29, 2023

View reviewed changes

monsieur-z marked this pull request as ready for review June 29, 2023 15:35

github-actions bot added the [Package] My Jetpack label Jun 29, 2023

monsieur-z force-pushed the add/jetpack-footer-generic-links branch from c6b92e6 to 53250cb Compare July 3, 2023 14:02

monsieur-z commented Jul 3, 2023

View reviewed changes

monsieur-z force-pushed the add/jetpack-footer-generic-links branch from 3a22723 to 9e01c1b Compare July 3, 2023 15:24

monsieur-z added 9 commits July 3, 2023 11:51

[not verified] JetpackFooter: add About, Privacy and Terms links

3978899

[not verified] Check plugin connection data in footer

7bedcc9

[not verified] Add comments

49ca46e

[not verified] Make Jetpack logo in My Jetpack footer smaller

3deda7c

[not verified] changelog

782b63a

[not verified] Attempt at fixing circular dep

3d56ac0

[not verified] Fix packages versions

e2622fd

[not verified] Fix TS issue

3efb04b

[not verified] Fix build

6dcd6fb

andrii-lysenko dismissed their stale review via 6e7d209 July 10, 2023 17:29

andrii-lysenko and others added 2 commits July 10, 2023 10:30

Merge branch 'trunk' into add/jetpack-footer-generic-links

e7882d4

update project versions

d42252c

andrii-lysenko added 2 commits July 10, 2023 11:07

add proper dependency

e113a9a

updating dependencies

bcea99d

bindlegirl added [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jul 13, 2023

andrii-lysenko added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Jul 13, 2023

Merge branch 'trunk' into add/jetpack-footer-generic-links

4d8748f

kraftbj mentioned this pull request Jul 19, 2023

Jetpack Footers: inconsistent behavior #31969

Closed

kraftbj added 2 commits July 19, 2023 13:41

Ver bump

2edb8f4

Merge remote-tracking branch 'origin/trunk' into add/jetpack-footer-g…

85b14ee

…eneric-links

bindlegirl previously approved these changes Jul 19, 2023

View reviewed changes

jeherve added 2 commits July 20, 2023 13:20

Fix merge conflict

2fe72a7

[not verified] Merge remote-tracking branch 'origin/trunk' into add/j…

42123f2

…etpack-footer-generic-links

jeherve dismissed bindlegirl’s stale review via 42123f2 July 20, 2023 11:24

jeherve approved these changes Jul 20, 2023

View reviewed changes

jeherve added [Status] Ready to Merge Go ahead, you can push that green button! and removed [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. labels Jul 20, 2023

jeherve enabled auto-merge (squash) July 20, 2023 11:31

jeherve merged commit 204cd1b into trunk Jul 20, 2023

jeherve deleted the add/jetpack-footer-generic-links branch July 20, 2023 11:57

github-actions bot removed the [Status] Ready to Merge Go ahead, you can push that green button! label Jul 20, 2023

darssen mentioned this pull request Dec 27, 2023

Fix/jetpack footer inconsistent behavior #34787

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JetpackFooter: add About, Privacy and Terms links #31627

JetpackFooter: add About, Privacy and Terms links #31627

monsieur-z commented Jun 28, 2023 •

edited

Loading

github-actions bot commented Jun 28, 2023 •

edited

Loading

github-actions bot commented Jun 28, 2023 •

edited

Loading

monsieur-z Jun 29, 2023

monsieur-z Jul 3, 2023

jeherve Jul 7, 2023

manzoorwanijk Sep 5, 2024

manzoorwanijk Sep 5, 2024 •

edited

Loading

manzoorwanijk Sep 6, 2024

monsieur-z Jul 3, 2023

manzoorwanijk Sep 5, 2024

manzoorwanijk Sep 5, 2024

andrii-lysenko commented Jul 10, 2023

bindlegirl commented Jul 14, 2023

kraftbj commented Jul 19, 2023

andrii-lysenko commented Jul 19, 2023

bindlegirl commented Jul 19, 2023

JetpackFooter: add About, Privacy and Terms links #31627

JetpackFooter: add About, Privacy and Terms links #31627

Conversation

monsieur-z commented Jun 28, 2023 • edited Loading

Proposed changes:

Other information:

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

github-actions bot commented Jun 28, 2023 • edited Loading

github-actions bot commented Jun 28, 2023 • edited Loading

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

manzoorwanijk Sep 5, 2024 • edited Loading

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

andrii-lysenko commented Jul 10, 2023

bindlegirl commented Jul 14, 2023

kraftbj commented Jul 19, 2023

andrii-lysenko commented Jul 19, 2023

bindlegirl commented Jul 19, 2023

monsieur-z commented Jun 28, 2023 •

edited

Loading

github-actions bot commented Jun 28, 2023 •

edited

Loading

github-actions bot commented Jun 28, 2023 •

edited

Loading

manzoorwanijk Sep 5, 2024 •

edited

Loading