Add Keywordmanager utility, services & controlpanel by jnptk · Pull Request #1 · kitconcept/kitconcept-keywordmanager

jnptk · 2026-03-30T09:03:03Z

No description provided.

davisagli

I reviewed the REST services, but not the keywordmanager tool or the frontend yet.

@jnptk Is the keywordmanager tool mostly copied from Products.PloneKeywordManager, or are there specific things you changed that you'd like me to check?

davisagli

It would be good to have functional tests for the API endpoints.

jnptk · 2026-04-22T13:04:13Z

@davisagli please review again. The single keyword view is not ready yet. Also, would it be worth the effort to have tests that create a new KeywordIndex so we can test if the indexName param in the keyword manager does what its supposed to do?

davisagli

@jnptk Nice work!

would it be worth the effort to have tests that create a new KeywordIndex so we can test if the indexName param in the keyword manager does what its supposed to do?

Nice to have, but not a blocker. Here's an example how to add an index programmatically: https://github.com/collective/collective.taxonomy/blob/53bf912ec7af0c0b0f43582c4146a898e1070be8/src/collective/taxonomy/behavior.py#L142

davisagli · 2026-04-23T22:01:30Z

@@ -0,0 +1,22 @@
+MANAGE_KEYWORDS_PERMISSION = "Manage Keywords"


This should be

Suggested change

MANAGE_KEYWORDS_PERMISSION = "Manage Keywords"

MANAGE_KEYWORDS_PERMISSION = "kitconcept.keywordmanager: Manage Keywords"

to match the permission name in permissions.zcml.

(It doesn't really matter, since this is only used to protect the methods on the tool, and it is always called from trusted Python rather than an untrusted Zope template or script, so the permissions are not enforced.)

I want to off-source the config options here into registry records maybe? For example if a project has a KeywordIndex that you should not be able to manage via the keyword manager you would put it in IGNORE_INDEXES, what do you think?

@jnptk I would only go to registry records here if there's a need for editing it through the web. A project can already do:

from kitconcept.keywordmanager import config config.IGNORE_INDEXES += ["my_custom_index"]

how would one include that python file so plone reads it? I want to write it down in the readme

davisagli · 2026-04-23T22:07:29Z

+            catalog.Indexes[indexName].uniqueValues(withLengths=withLengths)
+        )
+
+        # can we turn this into a yield?


I think we could but then I would rename the function to iterKeywords, to make it more obvious that it returns a generator. You'll have to change the return type to Generator[x] where x is the current return type, and Generator is imported from typing

davisagli · 2026-04-23T22:25:07Z

+
+    def test_response_invalid_index(self):
+        resp = self.api_session.get("/@keywords?idx=Bla")
+        assert resp.status_code == 500


Nitpick: usually we want to reserve 500 for errors that are totally unanticipated (because they'll probably trigger an alert in a monitoring system).

In this case I would make the REST service catch the ValueError from the tool, and re-raise it as a BadRequest.

This is low priority to fix though.

davisagli · 2026-04-23T22:25:43Z

+            data=json.dumps({"new_keyword": "document", "old_keywords": ["doc"]}),
+            headers={"Accept": "application/json"},
+        )
+        assert resp.status_code == 204


Make an assertion to confirm the keyword was updated.

davisagli · 2026-04-23T22:35:17Z

Nice work here.

davisagli · 2026-04-23T22:45:38Z

@sneridagh @ericof Do you recognize the error when corepack is enabled in the frontend image? https://github.com/kitconcept/kitconcept-keywordmanager/actions/runs/24860661321/job/72785922229?pr=1

jnptk · 2026-04-28T12:49:40Z

@davisagli how can I get the KeywordIndex a keyword is from to the KeywordView component? It works for now because standard Plone only has the Subject KeywordIndex and the keyword manager falls back to querying this index by default but if a user wants to view a keyword from a different index it won't work because the component doesn't know where the keyword came from so the keyword manager will query the Subject index...

davisagli · 2026-04-28T17:49:07Z

@jnptk I would change the route for KeywordView to path: '/controlpanel/keyword-manager/:keywordIndex/:id', and pass the index name as part of the path.

davisagli · 2026-05-05T16:00:48Z

+        <p className="description">
+          <FormattedMessage
+            id="keyword-manager-description"
+            defaultMessage="The Keyword Manager allows you to maintain the keywords used in your intranet. Start by selecting the keyword field you want to manage. You can then sort, filter, rename, merge, or delete individual keywords."


This is an add-on that might also be used in sites which are not an intranet.

Suggested change

defaultMessage="The Keyword Manager allows you to maintain the keywords used in your intranet. Start by selecting the keyword field you want to manage. You can then sort, filter, rename, merge, or delete individual keywords."

defaultMessage="The Keyword Manager allows you to maintain the keywords used in your website. Start by selecting the keyword field you want to manage. You can then sort, filter, rename, merge, or delete individual keywords."

davisagli · 2026-05-05T16:01:26Z

+                    selectedKeys !== 'all' && selectedKeys?.size === 0
+                  }
+                >
+                  <Icon name={replaceSVG} size="20px" />


We need a better icon here. I thought this one would reload the listing.

davisagli · 2026-05-06T02:10:56Z

+                    selectedKeys === 'all'
+                      ? keywords.items?.map((kw) => kw.name) ?? []
+                      : [...(selectedKeys as Set<string>)],
+                  );


This didn't work when I tested today. The whole page reloaded. You may need to add type="button" or add event.preventDefault() (to avoid accidentally triggering form submission) or add event.stopPropagation() to prevent the event from bubbling up to container elements.

davisagli · 2026-05-06T02:12:09Z

@jnptk Let me know if you'd like me to take a look at the failing tests.

jnptk added 2 commits March 23, 2026 17:17

wip

f28c11d

first working

04a0f9b

jnptk requested a review from davisagli March 30, 2026 09:03

jnptk added 4 commits March 30, 2026 11:44

make format

5fdf327

add endpoint to get KeywordIndex indexes

5f48385

add pagination

ef8cfa3

missing things for choosing the index thats queried

a7b577f

davisagli reviewed Apr 1, 2026

View reviewed changes

jnptk added 5 commits April 1, 2026 10:49

rename endpoint to [at]keywords

28bd1a5

make endpoint only available for site root

f264a46

add manage keywords permission

a9d8fcf

rename action path

2c358b3

request data validation

a32eef3

davisagli reviewed Apr 1, 2026

View reviewed changes

jnptk added 16 commits April 8, 2026 15:52

add tests for keywords service get & fix get methods reply

e390427

more tests

d15d190

fix query building in get method

23e095d

even more tests

52fbd94

different fixes & styling

04e1092

prepare for to make endpoint traversable + fixes & styling

49ea914

make endpoint traverseable

532b9b9

make format

e4d3307

fix typo in function import

8adddf7

various styling fixes

f17560d

rework single keyword view to use search endpoint

d1bb2fd

fix cursor for buttons outside the table

97d943f

typing for km utility

58360fe

implement sorting mechanisms & styling

dccb6db

fix tests

886a0e5

don't return sorted keywords

0d41438

jnptk added 4 commits April 21, 2026 14:37

support custom KeywordIndexes & more improvements

8dcc3dc

remove shadow from buttons

66717a3

update confirm modal

99e5130

move modals out of KeywordManager.tsx & more

3c79c07

jnptk requested a review from davisagli April 22, 2026 12:58

jnptk and others added 4 commits April 23, 2026 14:31

reuse DeleteModal component

8427764

Fix babel.config.js, extract i18n

ffe68ff

Run make format

efb3e5a

Fix storybook config

ca97f10

davisagli reviewed Apr 23, 2026

View reviewed changes

jnptk added 7 commits April 24, 2026 08:55

fix typos

0dd894d

remove unicode fallback for python 2

274e1cd

remove fallback for archetypes

4f07d0b

update permission name in config

abc1d54

pagination & styling for keyword view

ab4227f

add option to filter by type

5b0910f

add filtering options in keyword view

df09bdb

make keyword view aware of the index a keyword is from

bf7a769

davisagli reviewed May 5, 2026

View reviewed changes

davisagli reviewed May 6, 2026

View reviewed changes

update to volto 19.0.0-alpha.33

3656bb9

		@@ -0,0 +1,22 @@
		MANAGE_KEYWORDS_PERMISSION = "Manage Keywords"

	MANAGE_KEYWORDS_PERMISSION = "Manage Keywords"
	MANAGE_KEYWORDS_PERMISSION = "kitconcept.keywordmanager: Manage Keywords"

	defaultMessage="The Keyword Manager allows you to maintain the keywords used in your intranet. Start by selecting the keyword field you want to manage. You can then sort, filter, rename, merge, or delete individual keywords."
	defaultMessage="The Keyword Manager allows you to maintain the keywords used in your website. Start by selecting the keyword field you want to manage. You can then sort, filter, rename, merge, or delete individual keywords."

Conversation

jnptk commented Mar 30, 2026

Uh oh!

davisagli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davisagli left a comment

Choose a reason for hiding this comment

Uh oh!

jnptk commented Apr 22, 2026

Uh oh!

davisagli left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

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!

Uh oh!

Uh oh!

davisagli commented Apr 23, 2026

Uh oh!

jnptk commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davisagli commented Apr 28, 2026

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!

davisagli commented May 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jnptk commented Apr 28, 2026 •

edited

Loading