Start9/start-sdk
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-sdk.git synced 2026-03-26 02:11:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3 from Start9Labs/feature/migrations

Browse Source 
adds utility for writing migrations
This commit is contained in:
J M
2022-07-18 12:03:31 -06:00
committed by GitHub
parent 9f512e7fcc 47cf6de393
commit cb39f5f3ba
5 changed files with 336 additions and 257 deletions
Download Patch File Download Diff File Expand all files Collapse all files

253
emvar-lite/mod.ts
View File

@@ -1,253 +0,0 @@
const starSub = /((\d+\.)*\d+)\.\*/
function incrementLastNumber(list: number[]) {
const newList = [...list]
newList[newList.length - 1]++
return newList
}
/**
* Will take in a range, like `>1.2` or `<1.2.3.4` or `=1.2` or `1.*`
* and return a checker, that has the check function for checking that a version is in the valid
* @param range
* @returns
*/
export function rangeOf(range: string | Checker): Checker {
return Checker.parse(range)
}
/**
* Used to create a checker that will `and` all the ranges passed in
* @param ranges
* @returns
*/
export function rangeAnd(...ranges: (string | Checker)[]): Checker {
if (ranges.length === 0) {
throw new Error('No ranges given');
}
const [firstCheck, ...rest] = ranges;
return Checker.parse(firstCheck).and(...rest);
}
/**
* Used to create a checker that will `or` all the ranges passed in
* @param ranges
* @returns
*/
export function rangeOr(...ranges: (string | Checker)[]): Checker {
if (ranges.length === 0) {
throw new Error('No ranges given');
}
const [firstCheck, ...rest] = ranges;
return Checker.parse(firstCheck).or(...rest);
}
/**
* This will negate the checker, so given a checker that checks for >= 1.0.0, it will check for < 1.0.0
* @param range
* @returns
*/
export function notRange(range: string | Checker): Checker {
return rangeOf(range).not();
}
/**
* EmVar is a set of versioning of any pattern like 1 or 1.2 or 1.2.3 or 1.2.3.4 or ..
*/
export class EmVar {
/**
* Convert the range, should be 1.2.* or * into a emvar
* Or an already made emvar
* IsUnsafe
*/
static from(range: string | EmVar): EmVar {
if (range instanceof EmVar) {
return range
}
return EmVar.parse(range)
}
/**
* Convert the range, should be 1.2.* or * into a emvar
* IsUnsafe
*/
static parse(range: string): EmVar {
const values = range.split('.').map(x => parseInt(x));
for (const value of values) {
if (isNaN(value)) {
throw new Error(`Couldn't parse range: ${range}`);
}
}
return new EmVar(values);
}
private constructor(public readonly values: number[]) { }
/**
* Used when we need a new emvar that has the last number incremented, used in the 1.* like things
*/
public withLastIncremented() {
return new EmVar(incrementLastNumber(this.values))
}
public greaterThan(other: EmVar): boolean {
for (const i in this.values) {
if (other.values[i] == null) {
return true
}
if (this.values[i] > other.values[i]) {
return true;
}
if (this.values[i] < other.values[i]) {
return false;
}
}
return false;
}
public equals(other: EmVar): boolean {
if (other.values.length !== this.values.length) {
return false
}
for (const i in this.values) {
if (this.values[i] !== other.values[i]) {
return false;
}
}
return true;
}
public greaterThanOrEqual(other: EmVar): boolean {
return this.greaterThan(other) || this.equals(other);
}
public lessThanOrEqual(other: EmVar): boolean {
return !this.greaterThan(other);
}
public lessThan(other: EmVar): boolean {
return !this.greaterThanOrEqual(other);
}
}
/**
* A checker is a function that takes a version and returns true if the version matches the checker.
* Used when we are doing range checking, like saying ">=1.0.0".check("1.2.3") will be true
*/
export class Checker {
/**
* Will take in a range, like `>1.2` or `<1.2.3.4` or `=1.2` or `1.*`
* and return a checker, that has the check function for checking that a version is in the valid
* @param range
* @returns
*/
static parse(range: string | Checker): Checker {
if (range instanceof Checker) {
return range
}
range = range.trim();
if (range.indexOf('||') !== -1) {
return rangeOr(...range.split('||').map(x => Checker.parse(x)));
}
if (range.indexOf('&&') !== -1) {
return rangeAnd(...range.split('&&').map(x => Checker.parse(x)));
}
if (range === '*') return new Checker((version) => {
EmVar.from(version)
return true
});
if (range.startsWith('!')) {
return Checker.parse(range.substring(1)).not()
}
const starSubMatches = starSub.exec(range)
if (starSubMatches != null) {
const emVarLower = EmVar.parse(starSubMatches[1])
const emVarUpper = emVarLower.withLastIncremented()
return new Checker((version) => {
const v = EmVar.from(version);
return (v.greaterThan(emVarLower) || v.equals(emVarLower)) && !v.greaterThan(emVarUpper) && !v.equals(emVarUpper);
})
}
switch (range.substring(0, 2)) {
case '>=': {
const emVar = EmVar.parse(range.substring(2));
return new Checker((version) => {
const v = EmVar.from(version);
return v.greaterThanOrEqual(emVar)
})
}
case '<=': {
const emVar = EmVar.parse(range.substring(2));
return new Checker((version) => {
const v = EmVar.from(version);
return v.lessThanOrEqual(emVar);
})
}
}
switch (range.substring(0, 1)) {
case '>': {
console.log('greaterThan')
const emVar = EmVar.parse(range.substring(1));
return new Checker((version) => {
const v = EmVar.from(version);
return v.greaterThan(emVar);
})
}
case '<': {
const emVar = EmVar.parse(range.substring(1));
return new Checker((version) => {
const v = EmVar.from(version);
return v.lessThan(emVar)
})
}
case '=': {
const emVar = EmVar.parse(range.substring(1));
return new Checker((version) => {
const v = EmVar.from(version);
return v.equals(emVar);
})
}
}
throw new Error("Couldn't parse range: " + range);
}
constructor(
/**
* Check is the function that will be given a emvar or unparsed emvar and should give if it follows
* a pattern
*/
public readonly check: (value: string | EmVar) => boolean
) { }
public and(...others: (Checker | string)[]): Checker {
return new Checker((value) => {
if (!this.check(value)) {
return false;
}
for (const other of others) {
if (!Checker.parse(other).check(value)) {
return false
}
}
return true
});
}
public or(...others: (Checker | string)[]): Checker {
return new Checker((value) => {
if (this.check(value)) {
return true;
}
for (const other of others) {
if (Checker.parse(other).check(value)) {
return true
}
}
return false
});
}
public not(): Checker {
return new Checker((value) => !this.check(value));
}
}

269
emver-lite/mod.ts Normal file
View File

@@ -0,0 +1,269 @@
import { matches } from "../dependencies.ts";
const starSub = /((\d+\.)*\d+)\.\*/;
function incrementLastNumber(list: number[]) {
const newList = [...list];
newList[newList.length - 1]++;
return newList;
}
/**
* Will take in a range, like `>1.2` or `<1.2.3.4` or `=1.2` or `1.*`
* and return a checker, that has the check function for checking that a version is in the valid
* @param range
* @returns
*/
export function rangeOf(range: string | Checker): Checker {
return Checker.parse(range);
}
/**
* Used to create a checker that will `and` all the ranges passed in
* @param ranges
* @returns
*/
export function rangeAnd(...ranges: (string | Checker)[]): Checker {
if (ranges.length === 0) {
throw new Error("No ranges given");
}
const [firstCheck, ...rest] = ranges;
return Checker.parse(firstCheck).and(...rest);
}
/**
* Used to create a checker that will `or` all the ranges passed in
* @param ranges
* @returns
*/
export function rangeOr(...ranges: (string | Checker)[]): Checker {
if (ranges.length === 0) {
throw new Error("No ranges given");
}
const [firstCheck, ...rest] = ranges;
return Checker.parse(firstCheck).or(...rest);
}
/**
* This will negate the checker, so given a checker that checks for >= 1.0.0, it will check for < 1.0.0
* @param range
* @returns
*/
export function notRange(range: string | Checker): Checker {
return rangeOf(range).not();
}
/**
* EmVer is a set of versioning of any pattern like 1 or 1.2 or 1.2.3 or 1.2.3.4 or ..
*/
export class EmVer {
/**
* Convert the range, should be 1.2.* or * into a emver
* Or an already made emver
* IsUnsafe
*/
static from(range: string | EmVer): EmVer {
if (range instanceof EmVer) {
return range;
}
return EmVer.parse(range);
}
/**
* Convert the range, should be 1.2.* or * into a emver
* IsUnsafe
*/
static parse(range: string): EmVer {
const values = range.split(".").map((x) => parseInt(x));
for (const value of values) {
if (isNaN(value)) {
throw new Error(`Couldn't parse range: ${range}`);
}
}
return new EmVer(values);
}
private constructor(public readonly values: number[]) {}
/**
* Used when we need a new emver that has the last number incremented, used in the 1.* like things
*/
public withLastIncremented() {
return new EmVer(incrementLastNumber(this.values));
}
public greaterThan(other: EmVer): boolean {
for (const i in this.values) {
if (other.values[i] == null) {
return true;
}
if (this.values[i] > other.values[i]) {
return true;
}
if (this.values[i] < other.values[i]) {
return false;
}
}
return false;
}
public equals(other: EmVer): boolean {
if (other.values.length !== this.values.length) {
return false;
}
for (const i in this.values) {
if (this.values[i] !== other.values[i]) {
return false;
}
}
return true;
}
public greaterThanOrEqual(other: EmVer): boolean {
return this.greaterThan(other) || this.equals(other);
}
public lessThanOrEqual(other: EmVer): boolean {
return !this.greaterThan(other);
}
public lessThan(other: EmVer): boolean {
return !this.greaterThanOrEqual(other);
}
public compare(other: EmVer) {
if (this.equals(other)) {
return "equal" as const;
} else if (this.greaterThan(other)) {
return "greater" as const;
} else {
return "less" as const;
}
}
public compareForSort(other: EmVer) {
return matches.matches(this.compare(other))
.when("equal", () => 0 as const)
.when("greater", () => 1 as const)
.when("less", () => -1 as const)
.unwrap();
}
}
/**
* A checker is a function that takes a version and returns true if the version matches the checker.
* Used when we are doing range checking, like saying ">=1.0.0".check("1.2.3") will be true
*/
export class Checker {
/**
* Will take in a range, like `>1.2` or `<1.2.3.4` or `=1.2` or `1.*`
* and return a checker, that has the check function for checking that a version is in the valid
* @param range
* @returns
*/
static parse(range: string | Checker): Checker {
if (range instanceof Checker) {
return range;
}
range = range.trim();
if (range.indexOf("||") !== -1) {
return rangeOr(...range.split("||").map((x) => Checker.parse(x)));
}
if (range.indexOf("&&") !== -1) {
return rangeAnd(...range.split("&&").map((x) => Checker.parse(x)));
}
if (range === "*") {
return new Checker((version) => {
EmVer.from(version);
return true;
});
}
if (range.startsWith("!")) {
return Checker.parse(range.substring(1)).not();
}
const starSubMatches = starSub.exec(range);
if (starSubMatches != null) {
const emVarLower = EmVer.parse(starSubMatches[1]);
const emVarUpper = emVarLower.withLastIncremented();
return new Checker((version) => {
const v = EmVer.from(version);
return (v.greaterThan(emVarLower) || v.equals(emVarLower)) &&
!v.greaterThan(emVarUpper) && !v.equals(emVarUpper);
});
}
switch (range.substring(0, 2)) {
case ">=": {
const emVar = EmVer.parse(range.substring(2));
return new Checker((version) => {
const v = EmVer.from(version);
return v.greaterThanOrEqual(emVar);
});
}
case "<=": {
const emVar = EmVer.parse(range.substring(2));
return new Checker((version) => {
const v = EmVer.from(version);
return v.lessThanOrEqual(emVar);
});
}
}
switch (range.substring(0, 1)) {
case ">": {
console.log("greaterThan");
const emVar = EmVer.parse(range.substring(1));
return new Checker((version) => {
const v = EmVer.from(version);
return v.greaterThan(emVar);
});
}
case "<": {
const emVar = EmVer.parse(range.substring(1));
return new Checker((version) => {
const v = EmVer.from(version);
return v.lessThan(emVar);
});
}
case "=": {
const emVar = EmVer.parse(range.substring(1));
return new Checker((version) => {
const v = EmVer.from(version);
return v.equals(emVar);
});
}
}
throw new Error("Couldn't parse range: " + range);
}
constructor(
/**
* Check is the function that will be given a emver or unparsed emver and should give if it follows
* a pattern
*/
public readonly check: (value: string | EmVer) => boolean,
) {}
public and(...others: (Checker | string)[]): Checker {
return new Checker((value) => {
if (!this.check(value)) {
return false;
}
for (const other of others) {
if (!Checker.parse(other).check(value)) {
return false;
}
}
return true;
});
}
public or(...others: (Checker | string)[]): Checker {
return new Checker((value) => {
if (this.check(value)) {
return true;
}
for (const other of others) {
if (Checker.parse(other).check(value)) {
return true;
}
}
return false;
});
}
public not(): Checker {
return new Checker((value) => !this.check(value));
}
}

0
emvar-lite/test.ts → emver-lite/test.ts
View File

62
migrations.ts Normal file
View File

@@ -0,0 +1,62 @@
import { types as T } from "./mod.ts";
import { EmVer } from "./emver-lite/mod.ts";
import { matches } from "./dependencies.ts";
export type MigrationFn = (effects: T.Effects) => Promise<T.MigrationRes>;
export interface Migration {
up: MigrationFn;
down: MigrationFn;
}
export interface MigrationMapping {
[version: string]: Migration;
}
export function fromMapping(
migrations: MigrationMapping,
currentVersion: string,
): T.ExpectedExports.migration {
const directionShape = matches.literals("from", "to");
return async (
effects: T.Effects,
version: string,
direction?: unknown,
) => {
if (!directionShape.test(direction)) {
return { error: 'Must specify arg "from" or "to".' };
}
let configured = true;
const current = EmVer.parse(currentVersion);
const other = EmVer.parse(version);
const migrationsToRun = matches.matches(direction)
.when("from", () =>
Object.entries(migrations)
.map(([version, migration]) => ({
version: EmVer.parse(version),
migration,
})).filter(({ version }) =>
version.greaterThan(other) && version.lessThanOrEqual(current)
).sort((a, b) => a.version.compareForSort(b.version))
.map(({ migration }) => migration.up))
.when("to", () =>
Object.entries(migrations)
.map(([version, migration]) => ({
version: EmVer.parse(version),
migration,
})).filter(({ version }) =>
version.lessThanOrEqual(other) && version.greaterThan(current)
).sort((a, b) => b.version.compareForSort(a.version))
.map(({ migration }) => migration.down))
.unwrap();
for (const migration of migrationsToRun) {
configured = (await migration(effects)).configured && configured;
}
return { result: { configured } };
};
}

9
mod.ts
View File

@@ -1,5 +1,6 @@
export { matches, YAML } from './dependencies.ts'
export * as types from './types.ts'
export { matches, YAML } from "./dependencies.ts";
export * as types from "./types.ts";
export { exists } from './exists.ts'
export * as compat from './compat/mod.ts'
export { exists } from "./exists.ts";
export * as compat from "./compat/mod.ts";
export * as migrations from "./migrations.ts";