AI-generated content tile for exemplars #2626

bgoldowsky · 2025-08-18T12:46:34Z

Defines a new "AI" tile type. This is authored with a prompt, and generates content that is displayed in the document. The content is cached in Firestore.

Since this tile can be used in general ways, some renaming is included to remove 'exemplars' from naming related objects.
The prompt in the tile is augmented with a system prompt that can be set in the unit configuration (in settings.ai.systemPrompt).
The prompt is also augmented with the class document summaries that are generated nightly.
Add a 'show class summaries' button for viewing the class summaries (requires showAiSummary=true command line arg).
Add a way in that dialog to update the class summaries at will, to avoid having to wait for at-midnight to run.
Add some fixes to authoring to make sure the authorTools section in unit configuration is respected. This would be where the AI tile toolbar button would normally be included.

This adds NPM dependency markdown-to-jsx, so run npm install.

Note the Firebase functions in this PR have already been deployed to production for testing.

Additional tests, including Cypress tests for the new tile type, would be nice to add to this, but we ran out of time.

codecov · 2025-08-18T12:48:24Z

Codecov Report

❌ Patch coverage is 60.00000% with 70 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.73%. Comparing base (c68e614) to head (ae39805).
⚠️ Report is 32 commits behind head on master.

Files with missing lines	Patch %	Lines
src/components/document/summary-button.tsx	15.51%	48 Missing and 1 partial ⚠️
src/plugins/ai/ai-tile.tsx	82.53%	11 Missing ⚠️
src/plugins/ai/ai-utils.tsx	63.63%	4 Missing ⚠️
src/plugins/ai/ai-content.ts	83.33%	3 Missing ⚠️
src/lib/firestore.ts	0.00%	2 Missing ⚠️
src/register-tile-types.ts	50.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2626      +/-   ##
==========================================
- Coverage   86.83%   86.73%   -0.10%     
==========================================
  Files         783      789       +6     
  Lines       42342    42514     +172     
  Branches    10809    10836      +27     
==========================================
+ Hits        36768    36876     +108     
- Misses       5257     5320      +63     
- Partials      317      318       +1

Flag	Coverage Δ
cypress-regression	`78.07% <45.86%> (-0.13%)`	⬇️
cypress-smoke	`44.07% <13.53%> (-0.10%)`	⬇️
jest	`48.79% <48.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

cypress · 2025-08-18T12:48:41Z

collaborative-learning Run #16466

Run Properties: Passed #16466 • ae39805f7e: Don't call teacher work "Student work"

Project	`collaborative-learning`
Branch Review	`CLUE-240-ai-content`
Run status	`Passed #16466`
Run duration	`19m 15s`
Commit	`ae39805f7e: Don't call teacher work "Student work"`
Committer	`Boris Goldowsky`
View all properties for this run ↗︎

Test results
Failures	`0`
Flaky	`2`
Pending	`4`
Skipped	`0`
Passing	`149`
View all changes introduced in this branch ↗︎

Simplify some naming.

…authoring WIP: Authoring AI tile

Copilot

Pull Request Overview

This PR introduces a new AI tile type for generating dynamic content in exemplars. The AI tile accepts a prompt and generates content that is displayed in the document, with responses cached in Firestore to improve performance.

Adds AI tile registration and component infrastructure
Implements Firebase functions for content generation and class data summarization
Integrates OpenAI API for content generation with caching and locking mechanisms

Reviewed Changes

Copilot reviewed 33 out of 35 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/utilities/auth-utils.ts	Extracts production URL check into reusable function
src/register-tile-types.ts	Registers new AI tile type for dynamic loading
src/plugins/ai/*.ts	Core AI tile implementation with content model, component, and utilities
src/components/document/summary-button.tsx	Adds UI component for viewing AI-generated class summaries
shared/update-class-data-docs.ts	Refactors class data document processing for AI summarization
functions-v2/src/*.ts	Implements Firebase functions for AI content generation and class data processing
src/clue/app-config.json	Adds default AI system prompt configuration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-28T20:43:57Z

src/plugins/ai/ai-tile.tsx

+          setLastUpdated(new Date(timestamp._seconds*1000));
+        }


The direct access to _seconds suggests this is accessing a private Firebase Timestamp property. Consider using the public Timestamp API or converting the timestamp on the server side to avoid potential breaking changes if the internal structure changes.

Suggested change

setLastUpdated(new Date(timestamp._seconds*1000));

}

// Use public API if available, fallback to _seconds if necessary

if (timestamp && typeof timestamp.toDate === "function") {

setLastUpdated(timestamp.toDate());

} else if (timestamp && typeof timestamp._seconds === "number") {

setLastUpdated(new Date(timestamp._seconds * 1000));

}

functions-v2/src/get-ai-content.ts

Copilot · 2025-08-28T20:43:57Z

shared/update-class-data-docs.ts

+const portals: string[] = ["learn.concord.org"]; // Consider all classes on production.
+const demos = ["AITEST"]; // Consider only classes in this demo area.


The hardcoded portal and demo arrays limit flexibility. Consider making these configurable parameters or environment variables to support different deployment scenarios.

Suggested change

const portals: string[] = ["learn.concord.org"]; // Consider all classes on production.

const demos = ["AITEST"]; // Consider only classes in this demo area.

// Portals and demos can be configured via environment variables (comma-separated), or default to the current values.

const portals: string[] = process.env.PORTALS ? process.env.PORTALS.split(",").map(s => s.trim()) : ["learn.concord.org"]; // Consider all classes on production.

const demos: string[] = process.env.DEMOS ? process.env.DEMOS.split(",").map(s => s.trim()) : ["AITEST"]; // Consider only classes in this demo area.

Copilot · 2025-08-28T20:43:58Z

src/plugins/ai/ai-utils.tsx

+
+/**
+ * Convert the AI tile content model to a Text tile content model.
+ * The content of the Text tile will be the AI-generated content, converted to HTML for Slate.
+ * @param content - The AI tile content model
+ * @returns The Text tile content model
+ */
+export function switchToTextContent(content: any) {


The parameter type any reduces type safety. Consider defining a proper interface for the AI content or using the existing AIContentModelType.

Suggested change

/**

* Convert the AI tile content model to a Text tile content model.

* The content of the Text tile will be the AI-generated content, converted to HTML for Slate.

* @param content - The AI tile content model

* @returns The Text tile content model

*/

export function switchToTextContent(content: any) {

import type { AIContentModelType } from "../../models/tiles/ai/ai-content";

/**

* Convert the AI tile content model to a Text tile content model.

* The content of the Text tile will be the AI-generated content, converted to HTML for Slate.

* @param content - The AI tile content model

* @returns The Text tile content model

*/

export function switchToTextContent(content: AIContentModelType) {

scytacki · 2025-08-29T15:15:53Z

README.md

@@ -173,7 +173,7 @@ There are a number of URL parameters that can aid in testing:
 |`studentDocumentHistoryId`|string         |Open the history slider and move to the specified revision in the `studentDocument`.|
 |`portalDomain`  |string                   |Used for dev/qa of standalone auth, this overrides which portal is used for auth|
 |`firebaseEnv`   |`production`,`staging`   |Target Firebase project for data and functions|
-|`showAiSummary` |`true`                   |When set to true the "ai summary" button in the document editor|
+|`showAiSummary` |`true`                   |When set to true the "ai summary" button in the document editor and Student Work view|


scytacki · 2025-08-29T15:35:45Z

functions-v2/src/get-ai-content.ts

+  let errorMessage = "";
+  const lastUpdated = Timestamp.now();
+  try {
+    const response = await openai.invoke(messages);


Is there a limit to how long a firebase function can run? Will this return before that time runs out?
If this is an http request having it wait for multiple seconds while waiting for open ai will likely cause problems.

I have not noticed problems but I don't know what the limits are.

scytacki · 2025-08-29T15:52:06Z

src/plugins/ai/ai-registration.ts

+  Component: AIComponent,
+  tileEltClass: "ai-tool-tile",
+  Icon,
+  HeaderIcon: Icon   // TODO: if this ever becomes a "real" tile (used in student/teacher work) we'll need a HeaderIcon.


Is this tile used by teachers to configure a prompt for their student summary? So it is kind of used in teacher "work" if I'm understanding this correctly. Could you update this comment to clarify? Or maybe better would be to add some doc to the plugins/ai which describes how this tile is used.

The canonical use is that these tiles are authored in curriculum (specifically, in Exemplars) and not available to students or teachers. When copied into a student/teacher document, the AI tile is transformed into a Text tile.

scytacki

This looks really good. I just a left a few comments. I'd guess the timeout issue will be a problem sometime in the future, but I don't think there is time to address it now.

If you could add some doc describing the point of the new ai tile that would be the most useful.

bgoldowsky added 4 commits August 15, 2025 15:28

Create "AI" tile type that converts to Text on copy.

654810f

Copy relevant changes from CLUE-240-customized-curriculum branch.

1764f81

Call AI from AI tile

963dd98

Use showAiSummary command line flag

5ce7b32

bgoldowsky changed the base branch from master to CLUE-215-context-in-exemplars August 18, 2025 12:47

bgoldowsky added 6 commits August 18, 2025 10:11

Rename function; cleanups; fix test

f22d8ac

Use markdown-to-jsx

1d3aae6

Don't show prompt in read-only view.

b149f58

Use markdown-to-jsx for summary as well. Fix 'updating' bug.

f19a439

Change firestore path, add locking

8168902

Address PR comment

3904050

Base automatically changed from CLUE-215-context-in-exemplars to master August 19, 2025 13:40

Update summarize script for new db loc; remove broken test.

bc87679

github-actions bot temporarily deployed to development August 19, 2025 15:26 Inactive

bgoldowsky added 2 commits August 19, 2025 12:08

Made a basic icon

e50e83b

More function renaming; add test.

0b0ddf3

github-actions bot temporarily deployed to development August 19, 2025 20:15 Inactive

bgoldowsky added 2 commits August 19, 2025 16:48

Add updated date

692e99e

Improve test

ce0b153

github-actions bot temporarily deployed to development August 20, 2025 13:07 Inactive

lublagg and others added 3 commits August 20, 2025 15:52

checkpoint: authoring works with AI tile

cbc6616

Configure system prompt in unit config. Button to update summaries.

5ea4a43

Simplify some naming.

Add mock to test

411a697

github-actions bot temporarily deployed to development August 21, 2025 19:09 Inactive

Add production portal

9bd30c9

github-actions bot temporarily deployed to development August 28, 2025 12:15 Inactive

lublagg added 2 commits August 28, 2025 12:33

fix: failing tests

6fe5bee

Merge branch 'CLUE-240-ai-content' into CLUE-240-ai-content-authoring

35724a6

lublagg and others added 4 commits August 28, 2025 13:28

fix: support curriculum documents with ai tile

6473507

fix: don't render update button in authoring

61a2cb1

fix: mock getParentOfType in ai tile test

e680bdd

Merge pull request #2632 from concord-consortium/CLUE-240-ai-content-…

a96e267

…authoring WIP: Authoring AI tile

github-actions bot temporarily deployed to development August 28, 2025 20:22 Inactive

Cleanups

47bb9bd

bgoldowsky added the run regression label Aug 28, 2025

bgoldowsky requested a review from Copilot August 28, 2025 20:42

Copilot AI reviewed Aug 28, 2025

View reviewed changes

bgoldowsky marked this pull request as ready for review August 28, 2025 20:46

copilot comment

95dc28a

github-actions bot temporarily deployed to development August 28, 2025 20:47 Inactive

github-actions bot temporarily deployed to development August 28, 2025 20:54 Inactive

bgoldowsky requested a review from scytacki August 28, 2025 21:26

Don't call teacher work "Student work"

ae39805

github-actions bot deployed to development August 29, 2025 15:14 View deployment

scytacki approved these changes Aug 29, 2025

View reviewed changes

scytacki reviewed Aug 29, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

AI-generated content tile for exemplars #2626

AI-generated content tile for exemplars #2626

Uh oh!

bgoldowsky commented Aug 18, 2025 •

edited

Loading

Uh oh!

codecov bot commented Aug 18, 2025 •

edited

Loading

Uh oh!

cypress bot commented Aug 18, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

Copilot AI Aug 28, 2025

Uh oh!

scytacki Aug 29, 2025

Uh oh!

scytacki Aug 29, 2025

Uh oh!

bgoldowsky Aug 29, 2025

Uh oh!

scytacki Aug 29, 2025

Uh oh!

bgoldowsky Aug 29, 2025 •

edited

Loading

Uh oh!

scytacki left a comment

Uh oh!

Uh oh!

-          setLastUpdated(new Date(timestamp._seconds*1000));
-        }
+          // Use public API if available, fallback to _seconds if necessary
+          if (timestamp && typeof timestamp.toDate === "function") {
+            setLastUpdated(timestamp.toDate());
+          } else if (timestamp && typeof timestamp._seconds === "number") {
+            setLastUpdated(new Date(timestamp._seconds * 1000));
+          }

		const portals: string[] = ["learn.concord.org"]; // Consider all classes on production.
		const demos = ["AITEST"]; // Consider only classes in this demo area.

-const portals: string[] = ["learn.concord.org"]; // Consider all classes on production.
-const demos = ["AITEST"]; // Consider only classes in this demo area.
+// Portals and demos can be configured via environment variables (comma-separated), or default to the current values.
+const portals: string[] = process.env.PORTALS ? process.env.PORTALS.split(",").map(s => s.trim()) : ["learn.concord.org"]; // Consider all classes on production.
+const demos: string[] = process.env.DEMOS ? process.env.DEMOS.split(",").map(s => s.trim()) : ["AITEST"]; // Consider only classes in this demo area.

	\|`showAiSummary` \|`true` \|When set to true the "ai summary" button in the document editor and Student Work view\|
	\|`showAiSummary` \|`true` \|When set to true show the "ai summary" button in the document editor and Student Work view\|

AI-generated content tile for exemplars #2626

Are you sure you want to change the base?

AI-generated content tile for exemplars #2626

Uh oh!

Conversation

bgoldowsky commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

cypress bot commented Aug 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

collaborative-learning Run #16466

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 28, 2025

Choose a reason for hiding this comment

Uh oh!

scytacki Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

scytacki Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

bgoldowsky Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

scytacki Aug 29, 2025

Choose a reason for hiding this comment

Uh oh!

bgoldowsky Aug 29, 2025 • 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!

scytacki left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bgoldowsky commented Aug 18, 2025 •

edited

Loading

codecov bot commented Aug 18, 2025 •

edited

Loading

cypress bot commented Aug 18, 2025 •

edited

Loading

bgoldowsky Aug 29, 2025 •

edited

Loading