Replace codex-search package with a separate build in the codex package
Closed, ResolvedPublic2 Estimated Story Points
Actions

Assigned To

Authored By

	Catrope
	Apr 24 2023, 11:23 PM

Description

We build a separate build of Codex that only includes the TypeaheadSearch component and its dependencies, for use in the Vector search bar. Right now, we build that as a separate package in our repo, that has its own package.json, its own Vite config and everything else, and is published as a separate NPM package.

Instead, we should build the search-only build as part of the build process in the main codex package, by passing a different entry point to the build config (which will be much easier once T335323 is done). We should then publish these files as part of the codex package in NPM, and remove the separate codex-search package.

A CJS codex-search build is added to the Codex package
The codex-search package is removed from the Codex monorepo
MediaWiki is migrated to use the new build (see T347342)
The @wikimedia/codex-search package on NPM has been deprecated

Details

	Subject	Repo	Branch	Lines +/-
	build: Remove codex-search workspace	design/codex	main	+40 -633

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		CCiufo-WMF	T335317 [EPIC] Determine how to support code-splitting when using Codex inside MediaWiki
		Resolved		egardner	T335324 Replace codex-search package with a separate build in the codex package

Event Timeline

Catrope created this task.Apr 24 2023, 11:23 PM

Restricted Application removed a project: Patch-For-Review. · View Herald TranscriptApr 24 2023, 11:23 PM

Catrope moved this task from Inbox to Up Next on the Design-System-Team board.Apr 24 2023, 11:24 PM

Let's make sure this happens before the 1.0 release, since it involves moving some code around and also pulling the codex-search package from NPM or at least archiving it. Maybe this can be the final breaking change before we go into "real" semVer.

CCiufo-WMF moved this task from Up Next to Needs Refinement on the Design-System-Team board.Jun 16 2023, 4:29 PM

Catrope edited parent tasks, added: T335317: [EPIC] Determine how to support code-splitting when using Codex inside MediaWiki; removed: T335302: Improve / simplify Codex build system.Sep 6 2023, 4:35 AM

Catrope updated the task description. (Show Details)Sep 6 2023, 4:37 AM

Catrope mentioned this in T345688: Add CJS build with entry points for every component.Sep 6 2023, 4:41 AM

Per my comment over in https://phabricator.wikimedia.org/T345687#9146709, I question whether we should continue offering a UMD build of Codex at this point – I don't think we actually need this, and continuing to provide it may limit some of our build options or at least force us to resort to various hacky workflows.

CCiufo-WMF triaged this task as High priority.Sep 8 2023, 7:59 PM

bmartinezcalvo set the point value for this task to 2.Sep 11 2023, 5:17 PM

bmartinezcalvo edited projects, added Design-System-Team (Design-Systems-Sprint-8); removed Design-System-Team.

lwatson claimed this task.Sep 12 2023, 7:29 PM

lwatson moved this task from Committed to In Progress on the Design-System-Team (Design-Systems-Sprint-8) board.Sep 15 2023, 11:59 AM

egardner mentioned this in T346469: Is codex-search-styles stable for templates to use? What should templates do going forward?.Sep 19 2023, 6:29 PM

Change 959342 had a related patch set uploaded (by LWatson; author: LWatson):

[design/codex@main] [WIP] Build: Remove codex-search workspace

https://gerrit.wikimedia.org/r/959342

gerritbot added a project: Patch-For-Review.Sep 20 2023, 7:19 PM

egardner moved this task from In Progress to Pending Release on the Design-System-Team (Design-Systems-Sprint-8) board.Sep 22 2023, 8:41 PM

Change 959342 merged by jenkins-bot: