Add installer for FAIR protocol #71

rmccue · 2025-06-11T01:25:26Z

Work in progress.

Adds a new "Direct Install" screen to the plugins screen, which allows installing plugins directly by DID if you already know it. You can test it out with @afragen's test DID, did:plc:afjf7gsjzsqmgc7dlhb553mv.

It looks like this:

Screenshot.2025-06-11.at.21.53.02.mp4

Signed-off-by: Ryan McCue <me@ryanmccue.info>

afragen · 2025-06-11T21:15:09Z

While it says installing latest version - it's not. ☹️

But we can fix.

rmccue · 2025-06-11T21:25:00Z

I actually did already fix that in 170d228 - the video is outdated :)

afragen · 2025-06-11T21:36:32Z

If no version specified should we default to most current version and not just wp_die()?

rmccue · 2025-06-12T10:42:20Z

There's actually no way to get to the page without specifying a version, since the URL generation function requires a ReleaseDocument.

Signed-off-by: Ryan McCue <me@ryanmccue.info>

afragen · 2025-06-17T16:56:56Z

Updated for a few issues I found.

afragen · 2025-06-17T17:21:09Z

Need to deactivate Install button if plugin installed.

afragen · 2025-06-17T17:31:57Z

I think we will need a consensus on how to manage slugs for installation and updating. The changes I made use the dot org standard of the slug, but we need to think longer term about possible duplicates.

afragen · 2025-06-17T19:02:46Z

Last commit changes install slug to slug-did without the did:plc|web parts.

Signed-off-by: Ryan McCue <me@ryanmccue.info>

afragen · 2025-06-18T18:50:12Z

A couple of PRs for here, #114 and #115

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com> Signed-off-by: Andy Fragen <andy@thefragens.com> Signed-off-by: Colin Stewart <79332690+costdev@users.noreply.github.com> Co-authored-by: Andy Fragen <andy@thefragens.com>

costdev

Pre-approving, pending responses to the open questions/discussions.

costdev · 2025-07-22T16:53:49Z

inc/packages/did/class-did.php

+	 *
+	 * One of plc, web.
+	 */
+	public function get_type() : string;


@rmccue Are we changing this to get_method() and the corresponding constant in PLC/Web to METHOD for consistency with the spec? Or?

Changing to method consistently makes sense to me; I picked type without really thinking about it, but sticking to the standard term is better.

inc/packages/admin/namespace.php

inc/packages/class-upgrader.php

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com>

…\Packages (#184) Signed-off-by: Andy Fragen <andy@thefragens.com>

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com> Signed-off-by: Andy Fragen <andy@thefragens.com> Co-authored-by: Andy Fragen <andy@thefragens.com>

costdev · 2025-07-26T02:45:01Z

Updated video showing AJAX installing and using two plugins, one that uses a GitHub release asset and one that doesn't, showing the install process looks exactly the same.

updated-direct-install.mp4

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com>

joedolson

A couple UX issues, and an unhandled error path with invalid DIDs.

inc/packages/admin/namespace.php

inc/packages/did/class-plc.php

Signed-off-by: Andy Fragen <andy@thefragens.com> Co-authored-by: Colin Stewart <79332690+costdev@users.noreply.github.com>

Signed-off-by: Andy Fragen <andy@thefragens.com>

Signed-off-by: Joe Dolson <design@joedolson.com>

rmccue · 2025-07-27T15:11:38Z

inc/packages/admin/info.php

+use FAIR\Packages\MetadataDocument;
+use FAIR\Packages\ReleaseDocument;
+
+use function FAIR\Updater\get_packages;


This should be use on the namespace rather than the function.

rmccue · 2025-07-27T15:19:04Z

inc/updater/namespace.php

+function maybe_add_accept_header( $args, $url ) : array {
+	$releases = wp_cache_get( RELEASE_PACKAGES_CACHE_KEY ) ?: [];
+
+	if ( ! str_contains( $url, 'api.github.com' ) ) {


I really don't want to add this exception for a specific source if we can at all avoid it, and I'm pretty certain we can with a properly constructed standard Accept header.

Accept indicates data types in preferential order (as indicated by q=), so we should be able to use a "universal" Accept header, similar to browsers. Browsers send text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 eg

For example, Accept: application/zip;q=1.0, application/octet-stream;q=0.7, */*;q=0.1 would indicate we accept zips, then binary streams, then anything (in that order).

I'll test this out.

Fails in testing.

This is caused on the other side of things, where api.github.com is incorrectly wanting Accept: application/json despite giving a zip response. I've contacted GitHub Support.

It looks like GitHub are also not parsing the q parameter correctly, so */*;q=0.1 or */*;q=0 incorrectly receive priority over application/octet-stream. This is noncompliant with the HTTP spec afaik.

rmccue · 2025-07-27T15:20:19Z

inc/packages/admin/namespace.php

+	Updater\add_package_to_release_cache( $did );
+	add_filter( 'http_request_args', 'FAIR\\Updater\\maybe_add_accept_header', 20, 2 );


Given these functions aren't specific to the updater, and we're reusing them here, we should move them upwards into the Packages namespace imo.

Signed-off-by: Andy Fragen <andy@thefragens.com>

inc/packages/did/class-did.php

Signed-off-by: Andy Fragen <andy@thefragens.com>

rmccue added 6 commits June 10, 2025 20:39

Add first pass at installer

d72cb97

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Correct document property names to match spec

75f95a4

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Pull signing keys correctly from DID

278b80a

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Add first pass at info screen

8a8453f

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Cache DID documents for 5 minutes

52b0044

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Add missing admin UI file

d2e9ddf

Signed-off-by: Ryan McCue <me@ryanmccue.info>

rmccue marked this pull request as draft June 11, 2025 01:25

rmccue added 7 commits June 11, 2025 21:04

Pop open the plugin info from input

ed2bd62

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Use a proper action button

fb3aacf

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Give the install button a real URL

3342548

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Disable JS handling, for now

df80466

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Pull artifacts from the right variable

1e7dd7e

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Specify the version in the URL

170d228

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Catch errors in fetching metadata

e4621f9

Signed-off-by: Ryan McCue <me@ryanmccue.info>

rmccue added 2 commits June 12, 2025 21:57

Pull banners if available

67893c6

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Gate installer behind feature flag

9d8cf17

Signed-off-by: Ryan McCue <me@ryanmccue.info>

rmccue force-pushed the add-fair-installer branch from b3903d0 to 9d8cf17 Compare June 18, 2025 17:31

Merge branch 'main' into add-fair-installer

701e49c

Signed-off-by: Ryan McCue <me@ryanmccue.info>

Installer fixes 1 (#114)

4b1b90e

afragen mentioned this pull request Jun 25, 2025

add Git Updater Lite based updater for packages #131

Merged

Fix package install warning (#136)

d8e256a

afragen self-requested a review July 22, 2025 16:43

afragen approved these changes Jul 22, 2025

View reviewed changes

costdev approved these changes Jul 22, 2025

View reviewed changes

costdev reviewed Jul 22, 2025

View reviewed changes

joedolson reviewed Jul 22, 2025

View reviewed changes

inc/packages/admin/namespace.php Outdated Show resolved Hide resolved

costdev reviewed Jul 22, 2025

View reviewed changes

inc/packages/class-upgrader.php Outdated Show resolved Hide resolved

afragen reviewed Jul 23, 2025

View reviewed changes

inc/packages/class-upgrader.php Outdated Show resolved Hide resolved

costdev added 2 commits July 23, 2025 15:50

Explicitly associate the install note with the ID input field. (#183)

83e092f

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com>

Use installation strings when installing (#182)

cd27da7

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com>

costdev mentioned this pull request Jul 24, 2025

Refactor get_update_data() to use DID, move package functions to FAIR\Packages #184

Merged

afragen and others added 2 commits July 24, 2025 20:24

Refactor get_update_data() to use DID, move package functions to FAIR…

a94d694

…\Packages (#184) Signed-off-by: Andy Fragen <andy@thefragens.com>

AJAXify the "Install Now" button. (#185)

a4f1b90

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com> Signed-off-by: Andy Fragen <andy@thefragens.com> Co-authored-by: Andy Fragen <andy@thefragens.com>

afragen requested review from rmccuewp and removed request for rmccuewp July 26, 2025 01:39

Change install_plugin() to install_package(). (#186)

bee704d

Signed-off-by: costdev <79332690+costdev@users.noreply.github.com>

joedolson requested changes Jul 26, 2025

View reviewed changes

inc/packages/admin/namespace.php Show resolved Hide resolved

inc/packages/admin/namespace.php Show resolved Hide resolved

inc/packages/admin/namespace.php Outdated Show resolved Hide resolved

inc/packages/did/class-plc.php Show resolved Hide resolved

afragen and others added 4 commits July 26, 2025 12:09

Return WP_Error for incorrect DID (#188)

7df399d

Signed-off-by: Andy Fragen <andy@thefragens.com> Co-authored-by: Colin Stewart <79332690+costdev@users.noreply.github.com>

Remove code not used with JS FAIR package installation (#187)

016f4ed

Signed-off-by: Andy Fragen <andy@thefragens.com>

Make did field required

40b2a28

Signed-off-by: Joe Dolson <design@joedolson.com>

Simplify plugin ID field text and remove break.

c50d0b0

Signed-off-by: Joe Dolson <design@joedolson.com>

joedolson approved these changes Jul 26, 2025

View reviewed changes

You wouldn't believe how many times I've made this mistake.

8c9506e

Signed-off-by: Joe Dolson <design@joedolson.com>

rmccue commented Jul 27, 2025

View reviewed changes

Addressing Ryan's comments (#190)

9302e6b

Signed-off-by: Andy Fragen <andy@thefragens.com>

afragen reviewed Jul 27, 2025

View reviewed changes

inc/packages/did/class-did.php Outdated Show resolved Hide resolved

update to use method

b5c9f00

Signed-off-by: Andy Fragen <andy@thefragens.com>

afragen merged commit 9ce4b13 into main Jul 27, 2025
46 checks passed

afragen deleted the add-fair-installer branch July 27, 2025 16:37

		Updater\add_package_to_release_cache( $did );
		add_filter( 'http_request_args', 'FAIR\\Updater\\maybe_add_accept_header', 20, 2 );

Add installer for FAIR protocol #71

Add installer for FAIR protocol #71

Conversation

rmccue commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

afragen commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rmccue commented Jun 11, 2025

Uh oh!

afragen commented Jun 11, 2025

Uh oh!

rmccue commented Jun 12, 2025

Uh oh!

afragen commented Jun 17, 2025

Uh oh!

afragen commented Jun 17, 2025

Uh oh!

afragen commented Jun 17, 2025

Uh oh!

afragen commented Jun 17, 2025

Uh oh!

afragen commented Jun 18, 2025

Uh oh!

costdev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

costdev Jul 22, 2025

Choose a reason for hiding this comment

Uh oh!

rmccue Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

costdev commented Jul 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joedolson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmccue Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

rmccue Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

afragen Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

rmccue Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

rmccue Jul 27, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rmccue commented Jun 11, 2025 •

edited

Loading

afragen commented Jun 11, 2025 •

edited

Loading

costdev left a comment •

edited

Loading

costdev commented Jul 26, 2025 •

edited

Loading