:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
feat(data-catalog): save and approve when editing an approved metric (#122769)
Thiago Salvatore3a4bc7a04a6f
diff --git a/frontend/snapshots.yml b/frontend/snapshots.ymlindex 4cf841b12641..d091fd269609 100644--- a/frontend/snapshots.yml+++ b/frontend/snapshots.yml@@ -7276,6 +7276,14 @@ snapshots:hash: v1.k794b7964.813ee6fa8c0a5d7f47883c875a17acf297b9862e9e42414ced9f0a7add680faa.2Zjf5z5DUlOijGyDJtgDa1_D52Th6qvsI1Am1FslNI0products-data-catalog-metric-lineage--no-warehouse-access--light:hash: v1.k794b7964.d24fc4898fd69d316912802e328f3a6e2e94cee4cf106d8893597da97dbf73af.UOfef0QXupztuN6lJ1r5vYH5FiYFRHx_eqHRlY-34CQ+ products-data-catalog-new-metric--narrow-scene-with-table--dark:+ hash: v1.k794b7964.612300913154783461e647024e161dae3bc887fadc35fe3b397a986bcd5c9035.1kodjxCxylTRlTOWF95lcdrWm05jWbDd2ZVNxQYApVo+ products-data-catalog-new-metric--narrow-scene-with-table--light:+ hash: v1.k794b7964.075e14816af95799b47f2a367326ba6ed51bbbd4c08af95e0fd2b08fa83d94cb.-S5rEe2pnXLsj1HN-XR1ig6kqvSwKd8b2fgfL5zSfu0+ products-data-catalog-new-metric--sql-with-result--dark:+ hash: v1.k794b7964.c193797397e4219755a68e428a30e2f2792b516e81407ce0bba6afa5705e2864.AIwRUBWQZyXyZtQJ6xtmGkK_bUektmCAgrlSLXu1hvs+ products-data-catalog-new-metric--sql-with-result--light:+ hash: v1.k794b7964.a6b6357d6d7ca719f4d9508f35e647fb64c6749213f763b876d24ee1b2ab7fff.BjYXpwtfAhhCU2yo-a17U0kP6SkEF2gi5uAj69hUcsIproducts-data-modeling-lineage-graph--canvas--dark:hash: v1.k794b7964.dfc9cecd5fe04ca15b3030156b8a22b1e7e856ca02ba62a45acb9f18e8e4363f.OMoHNsARLj6RjX4bCuo2KF33IMbCanui8ZqWzGhIczkproducts-data-modeling-lineage-graph--canvas--light:diff --git a/products/data_catalog/frontend/DataCatalogMetricScene.tsx b/products/data_catalog/frontend/DataCatalogMetricScene.tsxindex 82603ece7f89..9946bd61ec3d 100644--- a/products/data_catalog/frontend/DataCatalogMetricScene.tsx+++ b/products/data_catalog/frontend/DataCatalogMetricScene.tsx@@ -155,11 +155,24 @@ export function DataCatalogMetricScene({ name }: DataCatalogMetricSceneLogicProptitle: 'Edit this approved metric?',content: (<div className="text-sm text-secondary">- Saving this change sets the metric back to proposed, so it will need to be approved again.+ Saving this change sets the metric back to proposed. Approve it again now, or leave it for a+ teammate to review.</div>),- primaryButton: { children: 'Save and reset to proposed', onClick: () => updateMetric(patch) },- secondaryButton: { children: 'Cancel' },+ primaryButton: {+ children: 'Save and approve',+ onClick: () => updateMetric(patch, true),+ disabledReason: metric.is_drifted+ ? 'This metric has drifted from its source insight. Refresh it before approving.'+ : undefined,+ 'data-attr': 'data-catalog-metric-save-and-approve',+ },+ secondaryButton: {+ children: 'Save and reset to proposed',+ onClick: () => updateMetric(patch),+ 'data-attr': 'data-catalog-metric-save-and-reset',+ },+ tertiaryButton: { children: 'Cancel' },})}diff --git a/products/data_catalog/frontend/DataCatalogNewMetricScene.stories.tsx b/products/data_catalog/frontend/DataCatalogNewMetricScene.stories.tsxnew file mode 100644index 000000000000..3d87a14495cd--- /dev/null+++ b/products/data_catalog/frontend/DataCatalogNewMetricScene.stories.tsx@@ -0,0 +1,92 @@+import type { Meta, StoryObj } from '@storybook/react'+import { useEffect } from 'react'++import { mswDecorator } from '~/mocks/browser'+import { EMPTY_PAGINATED_RESPONSE } from '~/mocks/handlers'++import { DataCatalogNewMetricScene } from './DataCatalogNewMetricScene'+import { dataCatalogNewMetricSceneLogic, NewMetricFormValues, SqlPreview } from './dataCatalogNewMetricSceneLogic'++const MONTHLY_ACTIVE_USERS: Partial<NewMetricFormValues> = {+ display_name: 'Monthly active users',+ name: 'monthly_active_users',+ definitionType: 'sql',+ sql: 'SELECT count(DISTINCT person_id) AS value\nFROM events\nWHERE timestamp > now() - INTERVAL 30 DAY',+ description: 'Distinct people who did any event in the last 30 days.',+ unit: 'users',+}++const SINGLE_NUMBER: SqlPreview = {+ sql: MONTHLY_ACTIVE_USERS.sql as string,+ columns: ['value'],+ rows: [[12345]],+ hasMore: false,+ warnings: [],+}++const LONG_NAMES: Partial<NewMetricFormValues> = {+ display_name: 'Weekly paying accounts on annual enterprise plans in North America',+ name: 'weekly_paying_accounts_on_annual_enterprise_plans_in_north_america',+ definitionType: 'sql',+ sql: 'SELECT plan, region, count() AS accounts FROM accounts GROUP BY plan, region',+ description: '',+ unit: '',+}++const BREAKDOWN: SqlPreview = {+ sql: LONG_NAMES.sql as string,+ columns: ['plan', 'region', 'accounts'],+ rows: [+ ['enterprise_annual', 'north_america', 412],+ ['enterprise_annual', 'europe', 287],+ ['team_monthly', 'north_america', 1904],+ ],+ hasMore: true,+ warnings: [],+}++function FilledNewMetricScene({+ form,+ preview,+ className,+}: {+ form: Partial<NewMetricFormValues>+ preview: SqlPreview+ className: string+}): JSX.Element {+ useEffect(() => {+ dataCatalogNewMetricSceneLogic.actions.setMetricFormValues(form)+ dataCatalogNewMetricSceneLogic.actions.runSqlPreviewSuccess(preview)+ }, [form, preview])++ return (+ <div className={className}>+ <DataCatalogNewMetricScene />+ </div>+ )+}++const meta: Meta = {+ title: 'Products/Data catalog/New metric',+ parameters: { layout: 'padded', viewMode: 'story' },+ decorators: [+ mswDecorator({+ get: {+ '/api/projects/:team_id/data_catalog/metrics/': EMPTY_PAGINATED_RESPONSE,+ '/api/environments/:team_id/insights/': EMPTY_PAGINATED_RESPONSE,+ '/api/projects/:team_id/insights/': EMPTY_PAGINATED_RESPONSE,+ },+ }),+ ],+}+export default meta++type Story = StoryObj<{}>++export const SqlWithResult: Story = {+ render: () => <FilledNewMetricScene form={MONTHLY_ACTIVE_USERS} preview={SINGLE_NUMBER} className="w-[960px]" />,+}++export const NarrowSceneWithTable: Story = {+ render: () => <FilledNewMetricScene form={LONG_NAMES} preview={BREAKDOWN} className="w-130" />,+}diff --git a/products/data_catalog/frontend/dataCatalogMetricSceneLogic.test.ts b/products/data_catalog/frontend/dataCatalogMetricSceneLogic.test.tsindex b05262ec14fc..4e20b74dd577 100644--- a/products/data_catalog/frontend/dataCatalogMetricSceneLogic.test.ts+++ b/products/data_catalog/frontend/dataCatalogMetricSceneLogic.test.ts@@ -52,6 +52,9 @@ jest.mock('./generated/api', () => ({dataCatalogMetricsRunCreate: jest.fn(),}))+const SAVED_AT = '2026-10-23T12:00:00.000000Z'+const EDITED_DEFINITION = { kind: 'HogQLQuery', query: 'SELECT 2' }+function buildMetric(overrides: Partial<DataCatalogMetricApi> = {}): DataCatalogMetricApi {return {id: 'metric-1',@@ -282,15 +285,51 @@ describe('dataCatalogMetricSceneLogic', () => {})- it('saving an approved metric edit reflects the proposed status from the response', async () => {+ it.each([+ ['Save and reset to proposed', false, 'proposed', 0],+ ['Save and approve', true, 'approved', 1],+ ])('%s on an approved metric edit', async (_button, approve, expectedStatus, approveCalls) => {;(dataCatalogMetricsPartialUpdate as jest.Mock).mockResolvedValue(- buildMetric({ status: 'proposed', definition: { kind: 'HogQLQuery', query: 'SELECT 2' } })+ buildMetric({ status: 'proposed', definition: EDITED_DEFINITION, updated_at: SAVED_AT })+ )+ ;(dataCatalogMetricsApproveCreate as jest.Mock).mockResolvedValue(+ buildMetric({ status: 'approved', definition: EDITED_DEFINITION }))- logic.actions.updateMetric({ definition: { kind: 'HogQLQuery', query: 'SELECT 2' } })+ logic.actions.updateMetric({ definition: EDITED_DEFINITION }, approve)await expectLogic(logic).toFinishAllListeners()- expect(logic.values.metric?.status).toEqual('proposed')+ expect((dataCatalogMetricsApproveCreate as jest.Mock).mock.calls).toEqual(+ Array(approveCalls).fill(['1', 'weekly_active_users', { expected_updated_at: SAVED_AT }])+ )+ expect(logic.values.metric?.status).toEqual(expectedStatus)+ })++ it('keeps a saved edit proposed when approving it fails', async () => {+ ;(dataCatalogMetricsPartialUpdate as jest.Mock).mockResolvedValue(+ buildMetric({ status: 'proposed', definition: EDITED_DEFINITION, updated_at: SAVED_AT })+ )+ ;(dataCatalogMetricsApproveCreate as jest.Mock).mockRejectedValue(new ApiError('changed', 409))++ logic.actions.updateMetric({ definition: EDITED_DEFINITION }, true)+ await expectLogic(logic).toFinishAllListeners()++ expect(logic.values.metric).toMatchObject({ status: 'proposed', definition: EDITED_DEFINITION })+ expect(lemonToast.warning).toHaveBeenCalledWith(+ 'Metric saved, but approving it failed. Approve it from the banner.'+ )+ expect(logic.values.mutating).toBe(false)+ })++ it('never approves when saving fails', async () => {+ ;(dataCatalogMetricsPartialUpdate as jest.Mock).mockRejectedValue(new ApiError('nope', 500))++ logic.actions.updateMetric({ definition: EDITED_DEFINITION }, true)+ await expectLogic(logic).toFinishAllListeners()++ expect(dataCatalogMetricsApproveCreate).not.toHaveBeenCalled()+ expect(logic.values.metric?.status).toEqual('approved')+ expect(logic.values.mutating).toBe(false)})it('surfaces refresh when approve returns 409 and leaves the metric untouched', async () => {diff --git a/products/data_catalog/frontend/dataCatalogMetricSceneLogic.tsx b/products/data_catalog/frontend/dataCatalogMetricSceneLogic.tsxindex 6fbbd98b7317..635972b07bda 100644--- a/products/data_catalog/frontend/dataCatalogMetricSceneLogic.tsx+++ b/products/data_catalog/frontend/dataCatalogMetricSceneLogic.tsx@@ -268,7 +268,11 @@ export interface dataCatalogMetricSceneLogicActions {startEditingMarkdown: () => {value: true}- updateMetric: (patch: PatchedDataCatalogMetricApi) => {+ updateMetric: (+ patch: PatchedDataCatalogMetricApi,+ approve?: boolean+ ) => {+ approve: booleanpatch: PatchedDataCatalogMetricApi}}@@ -313,7 +317,7 @@ export const dataCatalogMetricSceneLogic = kea<dataCatalogMetricSceneLogicType>(deleteMetric: true,renameMetric: (name: string) => ({ name }),renamedExternally: (name: string) => ({ name }),- updateMetric: (patch: PatchedDataCatalogMetricApi) => ({ patch }),+ updateMetric: (patch: PatchedDataCatalogMetricApi, approve: boolean = false) => ({ patch, approve }),setMutating: (mutating: boolean) => ({ mutating }),setEditingDefinition: (editingDefinition: boolean) => ({ editingDefinition }),setDraftSql: (draftSql: string) => ({ draftSql }),@@ -586,14 +590,28 @@ export const dataCatalogMetricSceneLogic = kea<dataCatalogMetricSceneLogicType>(actions.setMutating(false)}},- updateMetric: async ({ patch }) => {+ updateMetric: async ({ patch, approve }) => {if (values.mutating || isInvalidMetricName(props.name)) {return}actions.setMutating(true)try {- actions.setMetric(await dataCatalogMetricsPartialUpdate(projectId(), props.name, patch))- lemonToast.success('Metric saved')+ const saved = await dataCatalogMetricsPartialUpdate(projectId(), props.name, patch)+ actions.setMetric(saved)+ if (!approve) {+ lemonToast.success('Metric saved')+ return+ }+ try {+ actions.setMetric(+ await dataCatalogMetricsApproveCreate(projectId(), props.name, {+ expected_updated_at: saved.updated_at ?? undefined,+ })+ )+ lemonToast.success('Metric saved and approved')+ } catch {+ lemonToast.warning('Metric saved, but approving it failed. Approve it from the banner.')+ }} catch (error) {lemonToast.error(apiErrorDetail(error) || 'Could not save the metric. Try again.')} finally {