@sanity/migrate
Version:
Tooling for running data migrations on Sanity.io projects
439 lines (438 loc) • 17.3 kB
JavaScript
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
try {
var info = gen[key](arg);
var value = info.value;
} catch (error) {
reject(error);
return;
}
if (info.done) {
resolve(value);
} else {
Promise.resolve(value).then(_next, _throw);
}
}
function _async_to_generator(fn) {
return function() {
var self = this, args = arguments;
return new Promise(function(resolve, reject) {
var gen = fn.apply(self, args);
function _next(value) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
}
function _throw(err) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
}
_next(undefined);
});
};
}
function _define_property(obj, key, value) {
if (key in obj) {
Object.defineProperty(obj, key, {
value: value,
enumerable: true,
configurable: true,
writable: true
});
} else {
obj[key] = value;
}
return obj;
}
function _object_spread(target) {
for(var i = 1; i < arguments.length; i++){
var source = arguments[i] != null ? arguments[i] : {};
var ownKeys = Object.keys(source);
if (typeof Object.getOwnPropertySymbols === "function") {
ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function(sym) {
return Object.getOwnPropertyDescriptor(source, sym).enumerable;
}));
}
ownKeys.forEach(function(key) {
_define_property(target, key, source[key]);
});
}
return target;
}
function ownKeys(object, enumerableOnly) {
var keys = Object.keys(object);
if (Object.getOwnPropertySymbols) {
var symbols = Object.getOwnPropertySymbols(object);
if (enumerableOnly) {
symbols = symbols.filter(function(sym) {
return Object.getOwnPropertyDescriptor(object, sym).enumerable;
});
}
keys.push.apply(keys, symbols);
}
return keys;
}
function _object_spread_props(target, source) {
source = source != null ? source : {};
if (Object.getOwnPropertyDescriptors) {
Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
} else {
ownKeys(Object(source)).forEach(function(key) {
Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
});
}
return target;
}
function _ts_generator(thisArg, body) {
var f, y, t, _ = {
label: 0,
sent: function() {
if (t[0] & 1) throw t[1];
return t[1];
},
trys: [],
ops: []
}, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype), d = Object.defineProperty;
return d(g, "next", {
value: verb(0)
}), d(g, "throw", {
value: verb(1)
}), d(g, "return", {
value: verb(2)
}), typeof Symbol === "function" && d(g, Symbol.iterator, {
value: function() {
return this;
}
}), g;
function verb(n) {
return function(v) {
return step([
n,
v
]);
};
}
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while(g && (g = 0, op[0] && (_ = 0)), _)try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [
op[0] & 2,
t.value
];
switch(op[0]){
case 0:
case 1:
t = op;
break;
case 4:
_.label++;
return {
value: op[1],
done: false
};
case 5:
_.label++;
y = op[1];
op = [
0
];
continue;
case 7:
op = _.ops.pop();
_.trys.pop();
continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
_ = 0;
continue;
}
if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
_.label = op[1];
break;
}
if (op[0] === 6 && _.label < t[1]) {
_.label = t[1];
t = op;
break;
}
if (t && _.label < t[2]) {
_.label = t[2];
_.ops.push(op);
break;
}
if (t[2]) _.ops.pop();
_.trys.pop();
continue;
}
op = body.call(thisArg, _);
} catch (e) {
op = [
6,
e
];
y = 0;
} finally{
f = t = 0;
}
if (op[0] & 5) throw op[1];
return {
value: op[0] ? op[1] : void 0,
done: true
};
}
}
import { readdir } from 'node:fs/promises';
import { runCommand } from '@oclif/test';
import { testCommand } from '@sanity/cli-test';
import { afterEach, describe, expect, test, vi } from 'vitest';
import { resolveMigrationScript } from '../../../utils/migration/resolveMigrationScript.js';
import { ListMigrationCommand } from '../list.js';
vi.mock('node:fs/promises', function() {
return {
readdir: vi.fn()
};
});
vi.mock('../../../../../cli-core/src/config/findProjectRoot.js', function() {
return {
findProjectRoot: vi.fn().mockResolvedValue({
directory: '/test/project',
root: '/test/project',
type: 'studio'
})
};
});
vi.mock('../../../../../cli-core/src/config/cli/getCliConfig.js', function() {
return {
getCliConfig: vi.fn().mockResolvedValue({
api: {
projectId: 'test-project'
}
})
};
});
vi.mock('../../../utils/migration/resolveMigrationScript.js', function(importOriginal) {
return _async_to_generator(function() {
var actual;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
return [
4,
importOriginal()
];
case 1:
actual = _state.sent();
return [
2,
_object_spread_props(_object_spread({}, actual), {
isLoadableMigrationScript: actual.isLoadableMigrationScript,
resolveMigrationScript: vi.fn()
})
];
}
});
})();
});
var mockReaddir = vi.mocked(readdir);
var mockResolveMigrationScript = vi.mocked(resolveMigrationScript);
describe.skip('#migration:list', function() {
afterEach(function() {
vi.clearAllMocks();
});
test('--help works', function() {
return _async_to_generator(function() {
var stdout;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
return [
4,
runCommand([
'migration list',
'--help'
])
];
case 1:
stdout = _state.sent().stdout;
expect(stdout).toMatchInlineSnapshot('\n "List available migrations\n\n USAGE\n $ sanity migration list\n\n DESCRIPTION\n List available migrations\n\n EXAMPLES\n List all available migrations in the project\n\n $ sanity migration list\n\n "\n ');
return [
2
];
}
});
})();
});
test('lists migrations successfully with various formats', function() {
return _async_to_generator(function() {
var stdout;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
// Mock readdir to return both files and directories with different extensions
mockReaddir.mockResolvedValue([
{
isDirectory: function() {
return false;
},
name: 'add-author-field.ts'
},
{
isDirectory: function() {
return true;
},
name: 'migration-dir'
},
{
isDirectory: function() {
return false;
},
name: 'rename-tags.js'
}
]);
// Mock resolveMigrationScript for .ts file
mockResolveMigrationScript.mockResolvedValueOnce([
{
absolutePath: '/test/project/migrations/add-author-field.ts',
mod: {
default: {
migrate: vi.fn(),
title: 'Add author field to articles'
}
},
relativePath: 'migrations/add-author-field.ts'
}
]);
// Mock resolveMigrationScript for directory
mockResolveMigrationScript.mockResolvedValueOnce([
{
absolutePath: '/test/project/migrations/migration-dir/index.ts',
mod: {
default: {
migrate: vi.fn(),
title: 'Directory-based migration'
}
},
relativePath: 'migrations/migration-dir/index.ts'
}
]);
// Mock resolveMigrationScript for .js file
mockResolveMigrationScript.mockResolvedValueOnce([
{
absolutePath: '/test/project/migrations/rename-tags.js',
mod: {
default: {
migrate: vi.fn(),
title: 'Rename tags to categories'
}
},
relativePath: 'migrations/rename-tags.js'
}
]);
return [
4,
testCommand(ListMigrationCommand, [])
];
case 1:
stdout = _state.sent().stdout;
// Verify count
expect(stdout).toContain('Found 3 migrations in project');
// Verify .ts file (extension removed)
expect(stdout).toContain('add-author-field');
expect(stdout).not.toContain('add-author-field.ts');
expect(stdout).toContain('Add author field to articles');
// Verify directory
expect(stdout).toContain('migration-dir');
expect(stdout).toContain('Directory-based migration');
// Verify .js file (extension removed)
expect(stdout).toContain('rename-tags');
expect(stdout).not.toContain('rename-tags.js');
expect(stdout).toContain('Rename tags to categories');
expect(stdout).toContain('Run `sanity migration run <ID>` to run a migration');
return [
2
];
}
});
})();
});
test('handles empty migrations folder', function() {
return _async_to_generator(function() {
var stdout;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
// Mock readdir to return empty array
mockReaddir.mockResolvedValue([]);
return [
4,
testCommand(ListMigrationCommand, [])
];
case 1:
stdout = _state.sent().stdout;
expect(stdout).toContain('No migrations found in migrations folder of the project');
expect(stdout).toContain('Run `sanity migration create <NAME>` to create a new migration');
return [
2
];
}
});
})();
});
test('handles missing migrations folder', function() {
return _async_to_generator(function() {
var enoentError, stdout;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
// Mock readdir to throw ENOENT error
enoentError = new Error('ENOENT: no such file or directory');
Object.assign(enoentError, {
code: 'ENOENT'
});
mockReaddir.mockRejectedValue(enoentError);
return [
4,
testCommand(ListMigrationCommand, [])
];
case 1:
stdout = _state.sent().stdout;
expect(stdout).toContain('No migrations folder found in the project');
expect(stdout).toContain('Run `sanity migration create <NAME>` to create a new migration');
return [
2
];
}
});
})();
});
test('handles migration loading errors', function() {
return _async_to_generator(function() {
var _error_oclif, error;
return _ts_generator(this, function(_state) {
switch(_state.label){
case 0:
// Mock readdir to return migration files
mockReaddir.mockResolvedValue([
{
isDirectory: function() {
return false;
},
name: 'broken-migration.ts'
}
]);
// Mock resolveMigrationScript to throw error
mockResolveMigrationScript.mockRejectedValue(new Error('Syntax error in migration file'));
return [
4,
testCommand(ListMigrationCommand, [])
];
case 1:
error = _state.sent().error;
expect(error === null || error === void 0 ? void 0 : error.message).toContain('List migrations failed');
expect(error === null || error === void 0 ? void 0 : error.message).toContain('Syntax error in migration file');
expect(error === null || error === void 0 ? void 0 : (_error_oclif = error.oclif) === null || _error_oclif === void 0 ? void 0 : _error_oclif.exit).toBe(1);
return [
2
];
}
});
})();
});
});