feat: add Context Chat OCP API #53859

edward-ly · 2025-07-08T00:03:20Z

Resolves: Implement an OCP API for Context Chat #52852

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

marcelklehr · 2025-07-08T07:15:51Z

Looks good! You can suppress psalm errors for the OCA\ContextChat classes by adding them to the psalm.xml suppress handler.

lib/private/Server.php

julien-nc

It would be nice to have a isContextChatAvailable method in the content manager so providers could even avoid calling submitContent if it's not available.

There could be a new section in the docs (after "Submitting ContentItem data") about this new method.

marcelklehr · 2025-07-11T11:02:42Z

Ah, yes. Good point. OCA\ContextChat\Public\ContentManager would also have to implement this, then, which is a bit useless, but we can just return true there.

lib/private/ContextChat/ContentManager.php

Signed-off-by: Edward Ly <contact@edward.ly>

…ContentManager Signed-off-by: Edward Ly <contact@edward.ly>

Signed-off-by: Edward Ly <contact@edward.ly>

susnux · 2025-07-14T13:29:01Z

lib/public/ContextChat/ContentItem.php

+/**
+ * @since 32.0.0
+ */
+class ContentItem {


Should this class really be in OCP?
Would it not be better to have it an interface instead as we do everywhere else?

(and implementation in OC)

It's a data object that is supposed to be used be consumers of the API to submit data to context chat.

See docs on how this is intended to be used.

Can be helpful if the items are generated by the apps

susnux · 2025-07-14T13:49:00Z

lib/public/ContextChat/Type/UpdateAccessOp.php

+ */
+class UpdateAccessOp {
+	public const ALLOW = 'allow';
+	public const DENY = 'deny';
+}


Op? Should probably have a better understandable name?
Also why not use an enum instead?

This PR is based on an existing API in OCA\ContextChat\Public with the rationale being to change as little as possible for apps that already implement the old API.

ChristophWurst

Some comments

ChristophWurst · 2025-07-14T13:46:03Z

lib/public/ContextChat/IContentManager.php

+	 * @return void
+	 * @since 32.0.0
+	 */
+	public function registerContentProvider(string $appId, string $providerId, string $providerClass): void;


Could this be moved into the app bootstrap mechanism to be a bit more lightweight? The current implementation needs the content manager to be build to perform a registration. The bootstrap context is always built when we bootstrap apps, but only if the context chat content manager is really needed in a request it will be built

ChristophWurst · 2025-07-14T13:48:55Z

lib/public/ContextChat/ContentItem.php

+/**
+ * @since 32.0.0
+ */
+class ContentItem {


Can be helpful if the items are generated by the apps

ChristophWurst · 2025-07-14T13:49:19Z

lib/public/ContextChat/ContentItem.php

+	 * @since 32.0.0
+	 */
+	public function __construct(
+		public string $itemId,


nitpick: missing since tags for the properties

ChristophWurst · 2025-07-14T13:50:02Z

lib/public/ContextChat/IContentManager.php

@@ -0,0 +1,113 @@
+<?php


new classes do are not strict. it should not cause an issues to make the strict from the beginning, so I suggest to add the declare line for the newly added interfaces and classes

nickvergessen · 2025-07-14T13:55:07Z

lib/private/ContextChat/ContentManager.php

@@ -0,0 +1,54 @@
+<?php
+


Suggested change

declare(strict_types=1);

lib/private/ContextChat/ContentManager.php

lib/private/Server.php

edward-ly added this to the Nextcloud 32 milestone Jul 8, 2025

edward-ly added enhancement 3. to review Waiting for reviews php Pull requests that update Php code pending documentation This pull request needs an associated documentation update labels Jul 8, 2025

edward-ly requested a review from marcelklehr July 8, 2025 00:04

edward-ly force-pushed the feat/context-chat-ocp branch from 4dc4697 to 1290be2 Compare July 8, 2025 00:27

marcelklehr approved these changes Jul 8, 2025

View reviewed changes

edward-ly marked this pull request as ready for review July 8, 2025 15:11

edward-ly requested a review from a team as a code owner July 8, 2025 15:11

edward-ly requested review from icewind1991, yemkareems and sorbaugh and removed request for a team July 8, 2025 15:11

This was referenced Jul 8, 2025

refactor: extend OCP API for public classes nextcloud/context_chat#139

Open

feat(developer): add section documenting Context Chat OCP API nextcloud/documentation#13399

Merged

kyteinsky approved these changes Jul 9, 2025

View reviewed changes

kyteinsky reviewed Jul 9, 2025

View reviewed changes

lib/private/Server.php Outdated Show resolved Hide resolved

edward-ly force-pushed the feat/context-chat-ocp branch 2 times, most recently from 0291146 to ccbf226 Compare July 9, 2025 20:52

julien-nc requested changes Jul 11, 2025

View reviewed changes

lib/private/ContextChat/ContentManager.php Outdated Show resolved Hide resolved

edward-ly mentioned this pull request Jul 11, 2025

fix(developer): add isContextChatAvailable method to Context Chat OCP API nextcloud/documentation#13409

Merged

edward-ly force-pushed the feat/context-chat-ocp branch from 6a256a8 to 87d4253 Compare July 11, 2025 17:57

marcelklehr requested a review from julien-nc July 13, 2025 12:00

julien-nc approved these changes Jul 13, 2025

View reviewed changes

edward-ly added 2 commits July 14, 2025 09:50

feat: add Context Chat OCP API

8df384c

Signed-off-by: Edward Ly <contact@edward.ly>

chore: update autoloaders

d49b8f2

Signed-off-by: Edward Ly <contact@edward.ly>

edward-ly added 2 commits July 14, 2025 09:50

fix(psalm): suppress UndefinedClass error for OCA\ContextChat\Public\…

b5a3e40

…ContentManager Signed-off-by: Edward Ly <contact@edward.ly>

feat(ContextChat): add isContextChatAvailable method to OCP API

70204ea

Signed-off-by: Edward Ly <contact@edward.ly>

marcelklehr force-pushed the feat/context-chat-ocp branch from 87d4253 to 70204ea Compare July 14, 2025 07:50

susnux reviewed Jul 14, 2025

View reviewed changes

marcelklehr removed the pending documentation This pull request needs an associated documentation update label Jul 14, 2025

susnux reviewed Jul 14, 2025

View reviewed changes

ChristophWurst reviewed Jul 14, 2025

View reviewed changes

nickvergessen reviewed Jul 14, 2025

View reviewed changes

lib/private/ContextChat/ContentManager.php

@@ -0,0 +1,54 @@

<?php

Copy link

Member

nickvergessen Jul 14, 2025

Choose a reason for hiding this comment

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

Suggested change

declare(strict_types=1);

nickvergessen requested changes Jul 14, 2025

View reviewed changes

lib/private/ContextChat/ContentManager.php Show resolved Hide resolved

lib/private/Server.php Show resolved Hide resolved

Uh oh!

feat: add Context Chat OCP API #53859

Are you sure you want to change the base?

feat: add Context Chat OCP API #53859

Conversation

edward-ly commented Jul 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

marcelklehr commented Jul 8, 2025

Uh oh!

Uh oh!

julien-nc 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!

marcelklehr commented Jul 11, 2025

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!

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!

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

Uh oh!

Uh oh!

Uh oh!

edward-ly commented Jul 8, 2025 •

edited

Loading

julien-nc left a comment •

edited

Loading