Pro 8152 anchors by BoDonkey · Pull Request #5071 · apostrophecms/apostrophe

BoDonkey · 2025-09-11T14:07:32Z

Summary

Summarize the changes briefly, including which issue/ticket this resolves. If it closes an existing Github issue, include "Closes #[issue number]"
This PR updates the annotateAreaForExternalFront() method to accept annotateWidgetForExternalFront() methods from any widget module. This will allow for individual widgets to pass options to an external frontend, like Astro.

What are the specific steps to test this change?

For example:

Run the website and log in as an admin

Open a piece manager modal and select several pieces

Click the "Archive" button on the top left of the manager and confirm that it should proceed

Check that all pieces have been archived properly

In the starter-kit-astro-essentials backend add a project-level option to the image-widget.
In the frontend, modify the image widget to log the options from the frontmatter.
Add an image widget to any area and check the logs.

What kind of change does this PR introduce?

(Check at least one)

Make sure the PR fulfills these requirements:

It includes a) the existing issue ID being resolved, b) a convincing reason for adding this feature, or c) a clear description of the bug it resolves
The changelog is updated
Related documentation has been updated
Related tests have been updated

If adding a new feature without an already open issue, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

linear · 2025-09-11T14:07:34Z

PRO-8152 As an Astro developer I can use our anchors module without custom code at project level

boutell

Use area.getManager.

Provide an empty stub method in the base class of widgets so you don't have to do an if test and it is more self-documenting for widget developers. Also important to establish the pattern so that people can use extendMethods which would be thwarted if they had to check if it existed first.

In general though, this is great.

BoDonkey · 2025-09-12T18:28:40Z

Took me a minute, but I think this is what you want.

boutell

One small thing 🙏

boutell · 2025-09-12T18:56:38Z

+            self.apos.area.widgetManagers?.[item.type];
+
+          let widgetOptions = {};
+          if (manager && typeof manager.annotateWidgetForExternalFront === 'function') {


You don't need this if anymore. It's going to exist.

By adding it to the base class we've made it part of the contract you can expect.

I guess you can still do if (manager).

I thought I would have to error on the side of caution. Learning!

boutell · 2025-09-12T18:56:43Z

        });
+      },
+
+      annotateWidgetForExternalFront() {


boutell · 2025-09-15T12:10:31Z

-          };
-          if (widgetOptions && Object.keys(widgetOptions).length > 0) {
+          const widgetOptions = await manager.annotateWidgetForExternalFront() || {};
+          if (Object.keys(widgetOptions).length > 0) {


Why not always provide it, so people on the astro side don't have to drive defensively with ?.? An empty object isn't that expensive.

boutell · 2025-09-15T12:44:04Z

      // at least as an empty array.

-      annotateAreaForExternalFront(field, area) {
+      async annotateAreaForExternalFront(field, area) {


Does this really need to be async? It's a major performance hit when multiplied by every area and then every widget, and there's no async work being done to look up options. Also I don't think you changed anything where it's called, so there's probably just a promise showing up there?

My starting assumption is that this annotation work should not be async. It's meant to be very lightweight to minimize the impact of using an external frontend.

boutell · 2025-09-15T12:44:18Z

+          const manager = self.apos.area.getManager?.(item.type) ||
+            self.apos.area.widgetManagers?.[item.type];
+
+          const widgetOptions = await manager.annotateWidgetForExternalFront() || {};


Should not be async either.

boutell · 2025-09-15T12:44:43Z

        });
+      },
+
+      annotateWidgetForExternalFront() {


Noticing this is already not async (and that's good), I think "async" in the area annotation method might have been a discarded early thought that hung around?

boutell · 2025-09-15T12:45:32Z

Based on the way "async" was hanging around in that method and "await" was being used even though it was called synchronously, my impression is that this probably hasn't been tested yet in an Astro project?

…anchors

BoDonkey · 2025-09-15T15:28:14Z

After a bit of nonsense with getting apostrophe linked in, I removed the erroneous asyncs and confirmed that everything was functional in the starter-kit-astro-essentials with the improved @apostrophecms/anchors. All options now passed to the external front.

boutell · 2025-09-16T13:37:58Z


+### Fixes
+
+* Resolve inline image URLs correctly when in edit mode and not in the default locale.


It looks like one of Miro's PRs got caught up in this PR somehow. But I'm going to ignore it because I know I approved it.

The merge-base changed after approval.

BoDonkey added 3 commits September 10, 2025 15:03

Adds support for project-level options for external frontends

b2f369d

Remove parameter

2b0f0da

Merge remote-tracking branch 'origin/main' into pro-8152-anchors

e388e0a

BoDonkey requested a review from boutell September 11, 2025 14:07

PRO-8272: Resolve images (#5069)

0dd7caa

boutell requested changes Sep 12, 2025

View reviewed changes

BoDonkey added 2 commits September 12, 2025 14:02

response to first comments

f8286b8

Response to first comments

fa937e9

BoDonkey requested a review from boutell September 12, 2025 18:29

boutell requested changes Sep 12, 2025

View reviewed changes

BoDonkey added 2 commits September 12, 2025 15:02

Response to second comments

c5501e9

clean up

dc70b1e

BoDonkey requested a review from boutell September 12, 2025 19:19

boutell requested changes Sep 15, 2025

View reviewed changes

Add options to item, even if empty

0d03767

BoDonkey requested a review from boutell September 15, 2025 12:37

boutell requested changes Sep 15, 2025

View reviewed changes

BoDonkey added 10 commits September 15, 2025 09:24

Remove async

5524b4f

Adds support for project-level options for external frontends

3f7ca89

Remove parameter

4bf5bab

response to first comments

730219e

Response to first comments

cae8b19

Response to second comments

17a3f3f

clean up

5905c61

Add options to item, even if empty

bc93cab

Remove async

04c9a8c

Merge remote-tracking branch 'origin/pro-8152-anchors' into pro-8152-…

ce69f46

…anchors

BoDonkey requested a review from boutell September 15, 2025 15:28

boutell previously approved these changes Sep 16, 2025

View reviewed changes

BoDonkey requested a review from boutell September 21, 2025 09:44

boutell previously approved these changes Sep 22, 2025

View reviewed changes

BoDonkey closed this Sep 22, 2025


		### Fixes

		* Resolve inline image URLs correctly when in edit mode and not in the default locale.

Conversation

BoDonkey commented Sep 11, 2025

Summary

What are the specific steps to test this change?

What kind of change does this PR introduce?

Make sure the PR fulfills these requirements:

Uh oh!

linear Bot commented Sep 11, 2025

Uh oh!

boutell left a comment

Choose a reason for hiding this comment

Uh oh!

BoDonkey commented Sep 12, 2025

Uh oh!

boutell 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!

boutell commented Sep 15, 2025

Uh oh!

BoDonkey commented Sep 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants