fix(library): gate IndexNow on the ECS cutover, cover unpublished and renamed pages, and give customer stories speakable hooks

Author: waleedlatif1

.github/workflows/ci.yml

@@ -569,6 +569,9 @@ jobs:
       needs.promote.result == 'success' &&
       needs.trigger-upload.result == 'success' &&
       needs.promote.outputs.promoted == 'true'
+    outputs:
+      # The new app serves traffic; indexnow keys off this, not the later Trigger.dev promotion.
+      cutover: ${{ steps.cutover.outcome }}
     # Mostly waiting on the ECS cutover after a dependency install: the smallest runner is enough.
     runs-on: *runner-2vcpu
     # Leave setup/promotion headroom above the 70-minute cutover poll.
@@ -596,6 +599,7 @@ jobs:
       # An unchanged tag may belong to a failed or still-running earlier deploy.
       # Verify its latest cutover rather than treating tag equality as success.
       - name: Wait for ECS traffic cutover
+        id: cutover
         env:
           OVERALL_TIMEOUT: 4200
           APP_IMAGE_CHANGED: ${{ needs.promote.outputs.app_image_changed }}
@@ -646,7 +650,7 @@ jobs:
       github.event_name == 'push' &&
       github.ref == 'refs/heads/main' &&
       needs.promote.outputs.promoted == 'true' &&
-      needs.trigger-promote.result == 'success'
+      needs.trigger-promote.outputs.cutover == 'success'
     runs-on: *runner-2vcpu
     timeout-minutes: 5
     continue-on-error: true

apps/sim/app/(landing)/customers/components/customer-story-page/customer-story-page.tsx

@@ -28,7 +28,10 @@ export function CustomerStoryPage({ story, post, nextStory }: CustomerStoryPageP
       <article className={HOME_INSET}>
         <header className={cn('pb-12 max-sm:pb-8', LANDING_HERO_TOP_PADDING)}>
           <BackLink href='/customers' label='Customer stories' />
-          <h1 className='mt-7 max-w-[1100px] text-balance text-[64px] text-[var(--text-primary)] leading-[1.04] tracking-[-0.03em] max-sm:mt-5 max-sm:text-[36px] max-xl:text-[52px]'>
+          <h1
+            className='mt-7 max-w-[1100px] text-balance text-[64px] text-[var(--text-primary)] leading-[1.04] tracking-[-0.03em] max-sm:mt-5 max-sm:text-[36px] max-xl:text-[52px]'
+            data-speakable='headline'
+          >
             {post.title}
           </h1>
         </header>
@@ -72,7 +75,10 @@ export function CustomerStoryPage({ story, post, nextStory }: CustomerStoryPageP
           </aside>
 
           <div className='min-w-0 max-w-[740px]'>
-            <p className='mb-10 text-pretty text-[28px] text-[var(--text-primary)] leading-[1.3] tracking-[-0.015em] max-sm:text-[23px]'>
+            <p
+              className='mb-10 text-pretty text-[28px] text-[var(--text-primary)] leading-[1.3] tracking-[-0.015em] max-sm:text-[23px]'
+              data-speakable='description'
+            >
               {post.description}
             </p>
             <div className='[&_h2:first-child]:!mt-0 [&_:is(h1,h2,h3,h4,h5,h6,a,strong,b)]:font-normal [&_h2]:scroll-mt-28 [&_p]:text-pretty'>

scripts/ping-indexnow.test.ts

@@ -104,6 +104,33 @@ describe('collectIndexNowUrls', () => {
     ])
   })
 
+  it('submits a post that went from published to draft, since it now 404s', () => {
+    const { repo, urls } = fixture()
+    write(repo, `${LIBRARY}/published/index.mdx`, post(true))
+    expect(urls()).toEqual(['https://www.sim.ai/library', 'https://www.sim.ai/library/published'])
+  })
+
+  it('submits both the old and new URL when a comparison id changes', () => {
+    const { repo, urls } = fixture()
+    write(repo, `${COMPETITORS}/n8n.ts`, "export const p = {\n  id: 'n8n-io',\n}\n")
+    expect(urls()).toEqual([
+      'https://www.sim.ai/comparisons',
+      'https://www.sim.ai/comparisons/n8n',
+      'https://www.sim.ai/comparisons/n8n-io',
+    ])
+  })
+
+  it("keeps a deleted comparison when Sim's profile changes in the same release", () => {
+    const { repo, urls } = fixture()
+    write(repo, 'apps/sim/lib/compare/data/sim.ts', 'export const sim = 2\n')
+    git(repo, 'rm', '-q', `${COMPETITORS}/n8n.ts`)
+    expect(urls()).toEqual([
+      'https://www.sim.ai/comparisons',
+      'https://www.sim.ai/comparisons/n8n',
+      'https://www.sim.ai/comparisons/stack-ai',
+    ])
+  })
+
   it('submits nothing when no library or comparison source changed', () => {
     const { repo, urls } = fixture()
     write(repo, 'README.md', 'changed\n')

scripts/ping-indexnow.ts

@@ -45,10 +45,11 @@ function profileId(source: string): string | undefined {
 }
 
 /**
- * The public URLs whose source changed between two commits: each published library article
- * (renamed and deleted ones under their old slug too, so engines learn of the redirect or 404),
- * each comparison whose profile changed (every comparison when Sim's own profile did), and the
- * index page of each section that changed. Drafts are never submitted.
+ * The public URLs whose source changed between two commits: each library article published on
+ * either side (renamed, deleted, and newly drafted ones too, so engines learn of the 404), each
+ * comparison whose profile changed under its old and new id (every comparison when Sim's own
+ * profile did), and the index page of each section that changed. A post that was never published
+ * is never submitted.
  */
 export function collectIndexNowUrls(repo: string, base: string, head: string): string[] {
   const diff = git(repo, ['diff', '--name-status', '-M', base, head, '--']) ?? ''
@@ -67,21 +68,28 @@ export function collectIndexNowUrls(repo: string, base: string, head: string): s
   )
   for (const slug of slugs) {
     const index = `${LIBRARY_DIR}/${slug}/index.mdx`
-    const source = show(head, index) ?? show(base, index)
-    if (source !== null && !isDraft(source)) urls.add(`${SITE}/library/${slug}`)
+    const wasOrIsPublished = [show(base, index), show(head, index)].some(
+      (source) => source !== null && !isDraft(source)
+    )
+    if (wasOrIsPublished) urls.add(`${SITE}/library/${slug}`)
   }
   if (urls.size > 0) urls.add(`${SITE}/library`)
 
-  const profiles = paths.includes(SIM_PROFILE)
-    ? (git(repo, ['ls-tree', '--name-only', head, `${COMPETITORS_DIR}/`]) ?? '')
-        .split('\n')
-        .filter(Boolean)
-    : paths.filter((file) => path.dirname(file) === COMPETITORS_DIR && file.endsWith('.ts'))
-  const ids = profiles
-    .map((file) => profileId(show(head, file) ?? show(base, file) ?? ''))
-    .filter(Boolean)
+  const changedProfiles = paths.filter(
+    (file) => path.dirname(file) === COMPETITORS_DIR && file.endsWith('.ts')
+  )
+  const currentProfiles = paths.includes(SIM_PROFILE)
+    ? (git(repo, ['ls-tree', '--name-only', head, `${COMPETITORS_DIR}/`]) ?? '').split('\n')
+    : []
+  const ids = new Set(
+    [...new Set([...changedProfiles, ...currentProfiles])]
+      .filter(Boolean)
+      .flatMap((file) => [show(base, file), show(head, file)])
+      .map((source) => profileId(source ?? ''))
+      .filter((id): id is string => Boolean(id))
+  )
   for (const id of ids) urls.add(`${SITE}/comparisons/${id}`)
-  if (ids.length > 0) urls.add(`${SITE}/comparisons`)
+  if (ids.size > 0) urls.add(`${SITE}/comparisons`)
 
   return [...urls].sort()
 }