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(cli): add support for legacy timestamp #17276

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 12 additions & 0 deletions packages/cli/src/_internal/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ export function getCurrentYYYYMMDDHHmms() {
)}`;
}

export function LEGACY_getCurrentYYYYMMDDHHmms() {
const date = new Date();

return `${date.getUTCFullYear()}${padNumber(date.getUTCMonth() + 1, 2)}${padNumber(
date.getUTCDate(),
2,
)}${padNumber(date.getUTCHours(), 2)}${padNumber(date.getUTCMinutes(), 2)}${padNumber(
date.getUTCSeconds(),
2,
)}`;
}

export function padNumber(value: number, length: number): string {
return String(value).padStart(length, '0');
}
Expand Down
20 changes: 17 additions & 3 deletions packages/cli/src/api/generate-migration.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import fs from 'node:fs/promises';
import path from 'node:path';
import { SKELETONS_FOLDER } from '../_internal/skeletons.js';
import { getCurrentYYYYMMDDHHmms, slugify } from '../_internal/utils.js';
import {
LEGACY_getCurrentYYYYMMDDHHmms,
getCurrentYYYYMMDDHHmms,
slugify,
} from '../_internal/utils.js';

export const SUPPORTED_MIGRATION_FORMATS = ['sql', 'typescript', 'cjs', 'esm'] as const;
export type SupportedMigrationFormat = (typeof SUPPORTED_MIGRATION_FORMATS)[number];
Expand All @@ -17,12 +21,22 @@ export interface GenerateMigrationOptions {
format: SupportedMigrationFormat;
migrationName: string;
migrationFolder: string;
legacyTimestamp?: boolean;
}

export async function generateMigration(options: GenerateMigrationOptions): Promise<string> {
const { format, migrationName, migrationFolder } = options;
const { format, migrationName, migrationFolder, legacyTimestamp } = options;

let migrationFilename = '';

if (legacyTimestamp) {
migrationFilename += `${LEGACY_getCurrentYYYYMMDDHHmms()}`;
} else {
migrationFilename += `${getCurrentYYYYMMDDHHmms()}`;
}

migrationFilename += `-${slugify(migrationName)}`;

const migrationFilename = `${getCurrentYYYYMMDDHHmms()}-${slugify(migrationName)}`;
const migrationPath = path.join(migrationFolder, migrationFilename);

if (format === 'sql') {
Expand Down
20 changes: 17 additions & 3 deletions packages/cli/src/api/generate-seed.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import fs from 'node:fs/promises';
import path from 'node:path';
import { SKELETONS_FOLDER } from '../_internal/skeletons.js';
import { getCurrentYYYYMMDDHHmms, slugify } from '../_internal/utils.js';
import {
LEGACY_getCurrentYYYYMMDDHHmms,
getCurrentYYYYMMDDHHmms,
slugify,
} from '../_internal/utils.js';

export const SUPPORTED_SEED_FORMATS = ['sql', 'typescript', 'cjs', 'esm'] as const;
export type SupportedSeedFormat = (typeof SUPPORTED_SEED_FORMATS)[number];
Expand All @@ -17,12 +21,22 @@ export interface GenerateSeedOptions {
format: SupportedSeedFormat;
seedName: string;
seedFolder: string;
legacyTimestamp?: boolean;
}

export async function generateSeed(options: GenerateSeedOptions): Promise<string> {
const { format, seedName, seedFolder } = options;
const { format, seedName, seedFolder, legacyTimestamp } = options;

let seedFilename = '';

if (legacyTimestamp) {
seedFilename += `${LEGACY_getCurrentYYYYMMDDHHmms()}`;
} else {
seedFilename += `${getCurrentYYYYMMDDHHmms()}`;
}

seedFilename += `-${slugify(seedName)}`;

const seedFilename = `${getCurrentYYYYMMDDHHmms()}-${slugify(seedName)}`;
const seedPath = path.join(seedFolder, seedFilename);

if (format === 'sql') {
Expand Down
17 changes: 17 additions & 0 deletions packages/cli/src/commands/migration/generate.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,21 @@ describe('migration:generate', () => {
expect(Object.keys(asJson)).to.deep.eq(['path']);
expect(pathToFileURL(asJson.path).pathname).to.match(/migrations\/[\d\-t]{19}-unnamed/);
});

oclifTest()
.stdout()
.command([
'migration:generate',
'--format=sql',
'--name=test-migration',
'--legacyTimestamp',
'--json',
])
.it('supports specifying the legacyTimestamp option', async ctx => {
const asJson = JSON.parse(ctx.stdout);

expect(Object.keys(asJson)).to.deep.eq(['path']);
expect(pathToFileURL(asJson.path).pathname).to.match(/migrations\/[\d]{14}-test-migration/);
expect(await fs.readdir(asJson.path)).to.have.members(['up.sql', 'down.sql']);
});
});
7 changes: 6 additions & 1 deletion packages/cli/src/commands/migration/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ export class GenerateMigration extends SequelizeCommand<(typeof GenerateMigratio
summary: 'A short name for the migration file',
default: 'unnamed',
}),
legacyTimestamp: Flags.boolean({
summary: 'When enabled, use the legacy timestamp format from earlier versions of the CLI',
}),
};

static summary = 'Generates a new migration file';
Expand All @@ -26,16 +29,18 @@ export class GenerateMigration extends SequelizeCommand<(typeof GenerateMigratio
`<%= config.bin %> <%= command.id %>`,
`<%= config.bin %> <%= command.id %> --format=sql`,
`<%= config.bin %> <%= command.id %> --name="create users table"`,
`<%= config.bin %> <%= command.id %> --legacyTimestamp`,
];

async run(): Promise<{ path: string }> {
const { format, name: migrationName } = this.flags;
const { format, name: migrationName, legacyTimestamp } = this.flags;
const { migrationFolder } = config;

const migrationPath = await generateMigration({
format: format as SupportedMigrationFormat,
migrationName,
migrationFolder,
legacyTimestamp,
});

if (format === 'sql') {
Expand Down
11 changes: 11 additions & 0 deletions packages/cli/src/commands/seed/generate.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,15 @@ describe('seed:generate', () => {
expect(Object.keys(asJson)).to.deep.eq(['path']);
expect(pathToFileURL(asJson.path).pathname).to.match(/seeds\/[\d\-t]{19}-unnamed/);
});

oclifTest()
.stdout()
.command(['seed:generate', '--format=sql', '--name=test-seed', '--legacyTimestamp', '--json'])
.it('supports specifying the legacyTimestamp option', async ctx => {
const asJson = JSON.parse(ctx.stdout);

expect(Object.keys(asJson)).to.deep.eq(['path']);
expect(pathToFileURL(asJson.path).pathname).to.match(/seeds\/[\d]{14}-test-seed/);
expect(await fs.readdir(asJson.path)).to.have.members(['up.sql', 'down.sql']);
});
});
7 changes: 6 additions & 1 deletion packages/cli/src/commands/seed/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ export class GenerateSeed extends SequelizeCommand<(typeof GenerateSeed)['flags'
summary: 'A short name for the seed file',
default: 'unnamed',
}),
legacyTimestamp: Flags.boolean({
summary: 'When enabled, use the legacy timestamp format from earlier versions of the CLI',
}),
};

static summary = 'Generates a new seed file';
Expand All @@ -26,16 +29,18 @@ export class GenerateSeed extends SequelizeCommand<(typeof GenerateSeed)['flags'
`<%= config.bin %> <%= command.id %>`,
`<%= config.bin %> <%= command.id %> --format=sql`,
`<%= config.bin %> <%= command.id %> --name="users table test data"`,
`<%= config.bin %> <%= command.id %> --legacyTimestamp`,
];

async run(): Promise<{ path: string }> {
const { format, name: seedName } = this.flags;
const { format, name: seedName, legacyTimestamp } = this.flags;
const { seedFolder } = config;

const seedPath = await generateSeed({
format: format as SupportedSeedFormat,
seedName,
seedFolder,
legacyTimestamp,
});

if (format === 'sql') {
Expand Down