Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add blobs-migrate recipe #6418

Merged
merged 7 commits into from Mar 7, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
250 changes: 140 additions & 110 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -72,7 +72,7 @@
"dependencies": {
"@bugsnag/js": "7.20.2",
"@fastify/static": "6.10.2",
"@netlify/blobs": "6.5.0",
"@netlify/blobs": "^7.0.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is this the only dependency with a caret?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! We're pinning the exact versions of dependencies to avoid issues with transitive dependencies. It shouldn't be an issue here, since @netlify/blobs doesn't have any dependencies, but I've pinned it anyway in b0572b1.

"@netlify/build": "29.36.1",
"@netlify/build-info": "7.13.0",
"@netlify/config": "20.12.1",
Expand Down
17 changes: 13 additions & 4 deletions src/commands/recipes/recipes.ts
Expand Up @@ -11,11 +11,18 @@ import { getRecipe, listRecipes } from './common.js'

const SUGGESTION_TIMEOUT = 1e4

// @ts-expect-error TS(7031) FIXME: Binding element 'config' implicitly has an 'any' t... Remove this comment to see the full error message
export const runRecipe = async ({ config, recipeName, repositoryRoot }) => {
interface RunRecipeOptions {
args: string[]
command?: BaseCommand
config: unknown
recipeName: string
repositoryRoot: string
}

export const runRecipe = async ({ args, command, config, recipeName, repositoryRoot }: RunRecipeOptions) => {
const recipe = await getRecipe(recipeName)

return recipe.run({ config, repositoryRoot })
return recipe.run({ args, command, config, repositoryRoot })
}

export const recipesCommand = async (recipeName: string, options: OptionValues, command: BaseCommand): Promise<any> => {
Expand All @@ -26,8 +33,10 @@ export const recipesCommand = async (recipeName: string, options: OptionValues,
return command.help()
}

const args = command.args.slice(1)

try {
return await runRecipe({ config, recipeName: sanitizedRecipeName, repositoryRoot })
return await runRecipe({ args, command, config, recipeName: sanitizedRecipeName, repositoryRoot })
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We were previously not passing the command arguments to recipes, but it's useful when a recipe needs to take input from the user.

} catch (error) {
if (
// The ESM loader throws this instead of MODULE_NOT_FOUND
Expand Down
2 changes: 1 addition & 1 deletion src/lib/blobs/blobs.ts
@@ -1,7 +1,7 @@
import { Buffer } from 'buffer'
import path from 'path'

import { BlobsServer } from '@netlify/blobs'
import { BlobsServer } from '@netlify/blobs/server'
import { v4 as uuidv4 } from 'uuid'

import { log, NETLIFYDEVLOG } from '../../utils/command-helpers.js'
Expand Down
2 changes: 1 addition & 1 deletion src/lib/edge-functions/editor-helper.ts
Expand Up @@ -40,5 +40,5 @@ export const promptEditorHelper = async ({ NETLIFYDEVLOG, chalk, config, log, re
return
}

await runRecipe({ config, recipeName: 'vscode', repositoryRoot })
await runRecipe({ args: [], config, recipeName: 'vscode', repositoryRoot })
}