Telemetry: Add portable stories

code/lib/telemetry/package.json

@@ -51,6 +51,7 @@
     "detect-package-manager": "^2.0.1",
     "fetch-retry": "^5.0.2",
     "fs-extra": "^11.1.0",
+    "glob": "^10.0.0",
     "read-pkg-up": "^7.0.1"
   },
   "devDependencies": {

code/lib/telemetry/src/__fixtures__/.storybook/a.js

@@ -0,0 +1 @@
+// composeStory;

code/lib/telemetry/src/__fixtures__/a.js

@@ -0,0 +1 @@
+// composeStory;

code/lib/telemetry/src/__fixtures__/b.js

@@ -0,0 +1 @@
+// composeStories;

code/lib/telemetry/src/__fixtures__/b.txt

@@ -0,0 +1 @@
+composeStory

code/lib/telemetry/src/__fixtures__/foo/a.js

@@ -0,0 +1 @@
+// composeStory;

code/lib/telemetry/src/get-portable-stories-usage.test.ts

@@ -0,0 +1,19 @@
+import { describe, it, expect } from 'vitest';
+import { join } from 'path';
+
+import { getPortableStoriesFiles } from './get-portable-stories-usage';
+
+describe('getPortableStoriesFiles', () => {
+  it('should ignores node_modules, non-source files', async () => {
+    const base = join(__dirname, '__fixtures__');
+    const usage = (await getPortableStoriesFiles(base)).map((f) => f.replace(base, ''));
+    expect(usage).toMatchInlineSnapshot(`
+      [
+        "/b.js",
+        "/a.js",
+        "/foo/a.js",
+        "/.storybook/a.js",
+      ]
+    `);
+  });
+});

code/lib/telemetry/src/get-portable-stories-usage.ts

@@ -0,0 +1,51 @@
+import { readFile } from 'fs/promises';
+import { join } from 'path';
+import { glob } from 'glob';
+
+import { createFileSystemCache, resolvePathInStorybookCache } from '@storybook/core-common';
+
+const cache = createFileSystemCache({
+  basePath: resolvePathInStorybookCache('portable-stories'),
+  ns: 'storybook',
+  ttl: 24 * 60 * 60 * 1000,
+});
+
+export const containsPortableStories = async (filename: string) => {
+  if (/sb\-preview\/runtime.m?js$/i.test(filename)) return null;
+
+  const fileContent = await readFile(filename, 'utf-8');
+  const contains = /composeStor[y|ies]/g.test(fileContent);
+  return contains ? filename : null;
+};
+
+export const getPortableStoriesFiles = async (base: string) => {
+  const files = await glob('**/*.{js,mjs,cjs,jsx,ts,mts,cts,tsx}', {
+    ignore: ['**/node_modules/**', '**/storybook-static/**', '**/dist/**'],
+    dot: true,
+    cwd: base,
+  });
+
+  const hits = [];
+  const chunkSize = 10;
+  for (let i = 0; i < files.length; i += chunkSize) {
+    const chunk = files.slice(i, i + chunkSize);
+    const results = (
+      await Promise.all(chunk.map((f: string) => containsPortableStories(join(base, f))))
+    ).filter(Boolean);
+    if (results.length > 0) {
+      hits.push(...results);
+    }
+  }
+  return hits as string[];
+};
+
+const CACHE_KEY = 'portableStories';
+export const getPortableStoriesFileCount = async () => {
+  let cached = await cache.get(CACHE_KEY);
+  if (!cached) {
+    const files = await getPortableStoriesFiles(process.cwd());
+    cached = { usage: files.length };
+    await cache.set(CACHE_KEY, cached);
+  }
+  return cached.usage;
+};

code/lib/telemetry/src/storybook-metadata.ts

@@ -15,6 +15,7 @@ import { getMonorepoType } from './get-monorepo-type';
 import { cleanPaths } from './sanitize';
 import { getFrameworkInfo } from './get-framework-info';
 import { getChromaticVersionSpecifier } from './get-chromatic-version';
+import { getPortableStoriesFileCount } from './get-portable-stories-usage';
 
 export const metaFrameworks = {
   next: 'Next',
@@ -177,10 +178,12 @@ export const computeStorybookMetadata = async ({
   }
 
   const storybookVersion = storybookPackages[storybookInfo.frameworkPackage]?.version;
+  const portableStoriesFileCount = await getPortableStoriesFileCount();
 
   return {
     ...metadata,
     ...frameworkInfo,
+    portableStoriesFileCount,
     storybookVersion,
     storybookVersionSpecifier: storybookInfo.version,
     language,

code/lib/telemetry/src/types.ts

@@ -60,6 +60,7 @@ export type StorybookMetadata = {
   preview?: {
     usesGlobals?: boolean;
   };
+  portableStoriesFileCount?: number;
 };
 
 export interface Payload {

code/yarn.lock

@@ -6646,6 +6646,7 @@ __metadata:
     detect-package-manager: "npm:^2.0.1"
     fetch-retry: "npm:^5.0.2"
     fs-extra: "npm:^11.1.0"
+    glob: "npm:^10.0.0"
     nanoid: "npm:^4.0.2"
     node-fetch: "npm:^3.3.1"
     read-pkg-up: "npm:^7.0.1"