Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/cli/bin/bundle.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import ShopifyStacktraceyPlugin from '../../../bin/bundling/esbuild-plugin-stack
import ShopifyVSCodePlugin from '../../../bin/bundling/esbuild-plugin-vscode.js'
import GraphiQLImportsPlugin from '../../../bin/bundling/esbuild-plugin-graphiql-imports.js'
import CliKitDedupPlugin from '../../../bin/bundling/esbuild-plugin-dedup-cli-kit.js'
import {shopifyDevToolsDataPlugin} from './shopify-dev-tools-data.js'

const require = createRequire(import.meta.url)

Expand Down Expand Up @@ -39,6 +40,15 @@ const themeUpdaterDataPath = joinPath(themeUpdaterPath, '..', '..', 'data/*')
const hydrogenPath = dirname(require.resolve('@shopify/cli-hydrogen/package.json'))
const hydrogenAssets = joinPath(hydrogenPath, 'dist/assets/hydrogen/**/*')

const shopifyDevToolsDataPath = joinPath(process.cwd(), '../shopify-dev-tools/dist/data')
const shopifyDevToolsInternalApiIdsPath = joinPath(
process.cwd(),
'../shopify-dev-tools/src/internal/internal-api-ids.json',
)
const shopifyDevToolsInternalApiIds = Object.values(
JSON.parse(readFileSync(shopifyDevToolsInternalApiIdsPath, 'utf8')),
)

const commandEntryPoints = glob.sync('./src/cli/commands/**/*.ts', {
ignore: ['**/*.test.ts', '**/*.d.ts'],
})
Expand Down Expand Up @@ -109,6 +119,11 @@ esBuild({
GraphiQLImportsPlugin,
ShopifyStacktraceyPlugin,
CliKitDedupPlugin({require}),
shopifyDevToolsDataPlugin({
sourceDataDirectory: shopifyDevToolsDataPath,
targetDataDirectory: joinPath(process.cwd(), 'dist/data'),
internalApiIds: shopifyDevToolsInternalApiIds,
}),
copy({
// this is equal to process.cwd(), which means we use cwd path as base path to resolve `to` path
// if not specified, this plugin uses ESBuild.build outdir/outfile options as base path.
Expand Down
30 changes: 30 additions & 0 deletions packages/cli/bin/shopify-dev-tools-data.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
import {cpSync, mkdirSync, rmSync, statSync} from 'fs'
import {basename} from 'path'

const shouldCopyDataPath = (sourcePath, internalApiIds) => {
const sourceName = basename(sourcePath)

if (internalApiIds.some((apiId) => sourceName.includes(apiId))) return false
if (statSync(sourcePath).isDirectory()) return true

return sourceName === 'supported-versions-schema.json' || sourceName === 'index.json' || sourceName.endsWith('.gz')
}

export const copyShopifyDevToolsData = ({sourceDataDirectory, targetDataDirectory, internalApiIds}) => {
rmSync(targetDataDirectory, {recursive: true, force: true})
mkdirSync(targetDataDirectory, {recursive: true})
cpSync(sourceDataDirectory, targetDataDirectory, {
recursive: true,
filter: (sourcePath) => shouldCopyDataPath(sourcePath, internalApiIds),
})
}

export const shopifyDevToolsDataPlugin = ({sourceDataDirectory, targetDataDirectory, internalApiIds}) => ({
name: 'copy-shopify-dev-tools-data',
setup(build) {
build.onEnd(({errors}) => {
if (errors.length > 0) return
copyShopifyDevToolsData({sourceDataDirectory, targetDataDirectory, internalApiIds})
})
},
})
46 changes: 46 additions & 0 deletions packages/cli/bin/shopify-dev-tools-data.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import {existsSync, mkdirSync, mkdtempSync, rmSync, writeFileSync} from 'fs'
import {tmpdir} from 'os'
import {join} from 'path'

// eslint-disable-next-line import-x/no-extraneous-dependencies
import {describe, expect, test} from 'vitest'

import {copyShopifyDevToolsData} from './shopify-dev-tools-data.js'

describe('copyShopifyDevToolsData', () => {
test('copies runtime data without raw or internal schemas', () => {
const temporaryDirectory = mkdtempSync(join(tmpdir(), 'shopify-dev-tools-data-'))
const sourceDataDirectory = join(temporaryDirectory, 'source')
const targetDataDirectory = join(temporaryDirectory, 'target')

try {
mkdirSync(join(sourceDataDirectory, 'types', 'graphql'), {recursive: true})
writeFileSync(join(sourceDataDirectory, 'supported-versions-schema.json'), '{}')
writeFileSync(join(sourceDataDirectory, 'admin_2026-07.json.gz'), 'public schema')
writeFileSync(join(sourceDataDirectory, 'admin_2026-07.json'), 'raw public schema')
writeFileSync(join(sourceDataDirectory, 'bourgeois_unstable.json.gz'), 'internal schema')
writeFileSync(join(sourceDataDirectory, 'types', 'index.json'), '{}')
writeFileSync(join(sourceDataDirectory, 'types', 'graphql', 'index.d.ts.gz'), 'type declarations')
writeFileSync(join(sourceDataDirectory, 'types', 'graphql', 'index.d.ts'), 'raw type declarations')
mkdirSync(targetDataDirectory, {recursive: true})
writeFileSync(join(targetDataDirectory, 'stale.json.gz'), 'stale data')

copyShopifyDevToolsData({
sourceDataDirectory,
targetDataDirectory,
internalApiIds: ['bourgeois'],
})

expect(existsSync(join(targetDataDirectory, 'supported-versions-schema.json'))).toBe(true)
expect(existsSync(join(targetDataDirectory, 'admin_2026-07.json.gz'))).toBe(true)
expect(existsSync(join(targetDataDirectory, 'admin_2026-07.json'))).toBe(false)
expect(existsSync(join(targetDataDirectory, 'bourgeois_unstable.json.gz'))).toBe(false)
expect(existsSync(join(targetDataDirectory, 'types', 'index.json'))).toBe(true)
expect(existsSync(join(targetDataDirectory, 'types', 'graphql', 'index.d.ts.gz'))).toBe(true)
expect(existsSync(join(targetDataDirectory, 'types', 'graphql', 'index.d.ts'))).toBe(false)
expect(existsSync(join(targetDataDirectory, 'stale.json.gz'))).toBe(false)
} finally {
rmSync(temporaryDirectory, {recursive: true, force: true})
}
})
})
1 change: 1 addition & 0 deletions packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@
"@shopify/cli-kit": "4.5.0",
"@shopify/plugin-cloudflare": "4.5.0",
"@shopify/plugin-did-you-mean": "4.5.0",
"@shopify/shopify-dev-tools": "workspace:*",
"@shopify/theme": "4.5.0",
"@shopify/cli-hydrogen": "13.0.2",
"@types/global-agent": "3.0.0",
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/project.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
"build",
"cli-kit:generate-version",
"app:build",
"theme:build"
"theme:build",
"shopify-dev-tools:build"
],
"options": {
"command": "node bin/bundle",
Expand Down
3 changes: 3 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading