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(versioning): Add schema transform #23047

Merged
merged 8 commits into from Jul 1, 2023
Merged
Show file tree
Hide file tree
Changes from 2 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
30 changes: 2 additions & 28 deletions lib/modules/versioning/index.ts
@@ -1,13 +1,9 @@
import { logger } from '../../logger';
import versionings from './api';
import { isVersioningApiConstructor } from './common';
import * as semverCoerced from './semver-coerced';
import { Versioning } from './schema';
import type { VersioningApi, VersioningApiConstructor } from './types';

export * from './types';

const defaultVersioning = semverCoerced;

export const getVersioningList = (): string[] => Array.from(versionings.keys());
/**
* Get versioning map. Can be used to dynamically add new versioning type
Expand All @@ -18,27 +14,5 @@ export const getVersionings = (): Map<
> => versionings;

export function get(versioning: string | undefined): VersioningApi {
if (!versioning) {
logger.trace(
`Missing versioning, using ${defaultVersioning.id} as fallback.`
);
return defaultVersioning.api;
}
const [versioningName, ...versioningRest] = versioning.split(':');
const versioningConfig = versioningRest.length
? versioningRest.join(':')
: undefined;

const theVersioning = versionings.get(versioningName);
if (!theVersioning) {
logger.info(
{ versioning },
`Unknown versioning - defaulting to ${defaultVersioning.id}`
);
return defaultVersioning.api;
}
if (isVersioningApiConstructor(theVersioning)) {
return new theVersioning(versioningConfig);
}
return theVersioning;
return Versioning.parse(versioning);
}
14 changes: 14 additions & 0 deletions lib/modules/versioning/schema.spec.ts
@@ -0,0 +1,14 @@
import api from './api';
import { Versioning } from './schema';

describe('modules/versioning/schema', () => {
it('parses valid version strings', () => {
const versioning = Versioning.parse('semver');
expect(versioning).toBeDefined();
expect(versioning).toEqual(api.get('semver'));
});

it('throws an error for invalid version strings', () => {
expect(() => Versioning.parse('foobar')).toThrow();

Check failure on line 12 in lib/modules/versioning/schema.spec.ts

View workflow job for this annotation

GitHub Actions / test (1/1)

modules/versioning/schema › throws an error for invalid version strings

expect(received).toThrow() Received function did not throw at Object.<anonymous> (lib/modules/versioning/schema.spec.ts:12:46)
});
});
38 changes: 38 additions & 0 deletions lib/modules/versioning/schema.ts
@@ -0,0 +1,38 @@
import is from '@sindresorhus/is';
import { z } from 'zod';
import { logger } from '../../logger';
import versionings from './api';
import * as defaultVersioning from './semver-coerced';
import type { VersioningApi } from './types';

export const Versioning = z
.unknown()
zharinov marked this conversation as resolved.
Show resolved Hide resolved
.transform((versioningSpec): VersioningApi => {
if (!is.string(versioningSpec)) {
logger.debug(
{ versioning: versioningSpec },
`Versioning: invalid name, falling back to ${defaultVersioning.id}`
);
return defaultVersioning.api;
}

const [versioningName, ...versioningRest] = versioningSpec.split(':');

let versioning = versionings.get(versioningName);
if (!versioning) {
logger.info(
{ versioning: versioningSpec },
`Versioning: '${versioningSpec}' not found, falling back to ${defaultVersioning.id}`
);
return defaultVersioning.api;
}

if (is.function_(versioning)) {
const versioningConfig = versioningRest.length
? versioningRest.join(':')
: undefined;
versioning = new versioning(versioningConfig);
}

return versioning;
});