initial commit

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "firemorph",
+  "description": "Firestore migration tool",
+  "keywords": [
+    "firestore",
+    "firebase",
+    "migration",
+    "db"
+  ],
+  "files": [
+    "./dist"
+  ],
+  "version": "1.0.0",
+  "main": "./dist/src",
+  "types": "./dist/src/index.d.ts",
+  "bin": "./dist/src/cli.js",
+  "license": "MIT",
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "rm -rf ./dist && tsc"
+  },
+  "devDependencies": {
+    "@types/glob": "^7.1.3",
+    "@types/semver": "^7.3.4",
+    "typescript": "^4"
+  },
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "commander": "^7.1.0",
+    "firebase-admin": "^9.5.0",
+    "glob": "^7.1.6",
+    "semver": "^7.3.4"
+  }
+}

src/cli.ts

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander'
+import spec from '../package.json'
+import { migrate } from './'
+
+const program = new Command()
+program.version(spec.version).name(spec.name)
+
+program
+  .command('migrate')
+  .description('run migrations')
+  // .option('--dry-run', 'run simulation without committing changes')
+  .option('-m, --migrations <glob>', 'migration files', './migrations/*.js')
+  .option('--force', 'ignore remote state and rerun migrations')
+  .action(async (args) => {
+    await migrate({ directory: args.migrations, ignoreRemote: args.force })
+  })
+
+program.parse(process.argv)

src/index.ts

@@ -0,0 +1,117 @@
+import crypto from 'crypto'
+import path from 'path'
+import admin from 'firebase-admin'
+import semver from 'semver'
+import glob from 'glob'
+import chalk from 'chalk'
+
+const App = admin.initializeApp()
+const DB = admin.firestore()
+const Timestamp = admin.firestore.Timestamp
+const MigrationCollection = DB.collection('migrations')
+
+export type MigrationFN = (db: FirebaseFirestore.Firestore, firestore: typeof admin.firestore) => Promise<void>
+export type MigrationFile = {
+  version: string
+  name: string
+  fn: MigrationFN
+}
+
+enum MigrationResultStatus {
+  Successful = 'successful',
+  Failed = 'failed',
+}
+type MigrationResult = {
+  executed: FirebaseFirestore.Timestamp
+  version: string
+  status: MigrationResultStatus
+}
+
+export type Options = {
+  directory: string
+  delimiter: string
+  ignoreRemote: boolean
+}
+
+const defaults: Options = {
+  directory: './migrations',
+  delimiter: '__',
+  ignoreRemote: false,
+}
+
+const extension = /\..*$/
+
+async function gather(options: Options): Promise<MigrationFile[]> {
+  const files = glob
+    .sync(path.join(options.directory, '*.js'))
+    .filter((f) => f.includes(options.delimiter))
+    .map((f) => path.resolve(f))
+
+  const versions: string[] = []
+  const contents = await Promise.all(
+    files.map(async (f) => {
+      const [rawVersion, name] = path.basename(f).split(options.delimiter)
+
+      const version = semver.coerce(rawVersion)
+      if (!version) throw new Error(`Invalid version: "${rawVersion}".`)
+      if (versions.includes(version.version))
+        throw new Error(`Cannot have multiple files for version: ${version.version}`)
+      versions.push(version.version)
+      const migration = await import(f)
+      if (typeof migration.migration !== 'function') throw new Error(`No migrate function found in: ${f}`)
+      return {
+        version,
+        name: name.replace(extension, ''),
+        fn: migration.migration as MigrationFN,
+      }
+    })
+  )
+
+  const sorted = contents.sort((a, b) => (semver.gt(a.version, b.version) ? 1 : -1))
+  return sorted.map(({ version, ...rest }) => ({
+    ...rest,
+    version: version.version,
+  }))
+}
+
+function getIdFromMigration(migration: MigrationFile): string {
+  return crypto.createHash('sha256').update(migration.version).digest('hex')
+}
+
+function printMigration(migration: MigrationFile, msg: string) {
+  console.log(chalk.underline(`Migration ${chalk.bold(migration.version)}:`), msg)
+}
+
+async function runMigrations(migrations: MigrationFile[], options: Options) {
+  for (const migration of migrations) {
+    const id = getIdFromMigration(migration)
+    const remoteDoc = await MigrationCollection.doc(id).get()
+    const remote = remoteDoc.data() as MigrationResult | undefined
+    if (!options.ignoreRemote && remote && remote.status === MigrationResultStatus.Successful) {
+      printMigration(migration, '🔧 Already run.')
+      continue
+    }
+
+    const result: MigrationResult = {
+      version: migration.version,
+      executed: Timestamp.now(),
+      status: MigrationResultStatus.Successful,
+    }
+    try {
+      await migration.fn(DB, admin.firestore)
+      await remoteDoc.ref.set(result)
+      printMigration(migration, chalk.green(`✅ Success`))
+    } catch (e) {
+      await remoteDoc.ref.set({ ...result, status: MigrationResultStatus.Failed })
+      printMigration(migration, chalk.red(`❌ Error while running.`))
+      console.error(e)
+      break
+    }
+  }
+}
+
+export async function migrate(options?: Partial<Options>) {
+  const merged: Options = Object.assign(defaults, options)
+  const migrations = await gather(merged)
+  await runMigrations(migrations, merged)
+}

tsconfig.json

@@ -0,0 +1,73 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true /* Enable incremental compilation */,
+    "target": "es2018" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    "outDir": "./dist" /* Redirect output structure to the directory. */,
+    // "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+    "resolveJsonModule": true,
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "strictNullChecks": true /* Enable strict null checks. */,
+    "strictFunctionTypes": true /* Enable strict checking of function types. */,
+    "strictBindCallApply": true /* Enable strict 'bind', 'call', and 'apply' methods on functions. */,
+    "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
+    "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
+    "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                             /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+  },
+  "include": ["./src", "./package.json"]
+}