Initial setup

Author: harazdovskiy

.circleci/config.yml

@@ -0,0 +1,33 @@
+version: 2.1
+
+orbs:
+  node: circleci/[email protected]
+
+parameters:
+  node_version:
+    type: string
+    default: '16.15.0'
+
+commands:
+  install_deps:
+    steps:
+      - node/install-packages:
+          pkg-manager: yarn
+          cache-version: v1-all
+          cache-only-lockfile: true
+          app-dir: ~/repo
+          override-ci-command: yarn install --pure-lockfile --no-progress
+      - run: sudo apt-get -q update && sudo apt-get -y install openjdk-17-jdk
+
+jobs:
+  build:
+    executor:
+      name: node/default
+      tag: << pipeline.parameters.node_version >>
+    working_directory: ~/repo
+    steps:
+      - checkout
+      - install_deps
+      - run: yarn test
+      - run: yarn type-check
+      - run: yarn lint:ci

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2

.eslintignore

@@ -0,0 +1,5 @@
+coverage/
+lib/
+renovate.json
+tsconfig.json
+package.json

.eslintrc

@@ -0,0 +1,9 @@
+{
+  "root": true,
+  "extends": [
+    "@shelf/eslint-config/typescript"
+  ],
+  "rules": {
+    "@typescript-eslint/no-non-null-assertion": "off"
+  }
+}

.gitignore

@@ -0,0 +1,7 @@
+.idea/
+.DS_Store
+node_modules/
+yarn.lock
+lib/
+!.husky/_/husky.sh
+!.husky/_/husky.sh

.husky/_/husky.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+if [ -z "$husky_skip_init" ]; then
+  debug () {
+    if [ "$HUSKY_DEBUG" = "1" ]; then
+      echo "husky (debug) - $1"
+    fi
+  }
+
+  readonly hook_name="$(basename "$0")"
+  debug "starting $hook_name..."
+
+  if [ "$HUSKY" = "0" ]; then
+    debug "HUSKY env variable is set to 0, skipping hook"
+    exit 0
+  fi
+
+  if [ -f ~/.huskyrc ]; then
+    debug "sourcing ~/.huskyrc"
+    . ~/.huskyrc
+  fi
+
+  export readonly husky_skip_init=1
+  sh -e "$0" "$@"
+  exitCode="$?"
+
+  if [ $exitCode != 0 ]; then
+    echo "husky - $hook_name hook exited with code $exitCode (error)"
+  fi
+
+  exit $exitCode
+fi

.husky/post-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+git update-index --again

.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+yarn lint-staged

.npmrc

@@ -0,0 +1 @@
+package-lock=false

README.md

@@ -0,0 +1,40 @@
+# postgres-local [![CircleCI](https://circleci.com/gh/shelfio/postgres-local/tree/master.svg?style=svg)](https://circleci.com/gh/shelfio/postgres-local/tree/master) ![](https://img.shields.io/badge/code_style-prettier-ff69b4.svg) [![npm (scoped)](https://img.shields.io/npm/v/@shelf/postgres-local.svg)](https://www.npmjs.com/package/@shelf/postgres-local)
+
+> Run any version of Postgres locally
+
+## Usage
+
+### 0. Install
+
+```
+$ yarn add @shelf/postgres-local --dev
+```
+
+### 1. Start Postgres - TO BE DONE
+
+```js
+import {start} from '@shelf/postgres-local';
+
+await start({});
+```
+
+### 2. Stop Postgres - TO BE DONE
+
+```js
+import {stop} from '@shelf/postgres-local';
+
+stop();
+```
+
+## Publish
+
+```sh
+$ git checkout master
+$ yarn version
+$ yarn publish
+$ git push origin master --tags
+```
+
+## License
+
+MIT © [Shelf](https://shelf.io)

licence

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Gemshelf Inc. (shelf.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@shelf/postgres-local",
+  "version": "1.0.0",
+  "description": "Run 14 version of Postgres locally",
+  "keywords": [
+    "postgres",
+    "postgres local"
+  ],
+  "homepage": "https://github.com/shelfio/postgres-local#readme",
+  "bugs": {
+    "url": "https://github.com/shelfio/postgres-local/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shelfio/postgres-local.git"
+  },
+  "license": "MIT",
+  "author": "Dmytro Harazdovskyi",
+  "files": [
+    "lib"
+  ],
+  "main": "lib/index.js",
+  "types": "./lib/index.d.ts",
+  "scripts": {
+    "build": "rm -rf lib/ && yarn build:types && yarn build:code",
+    "build:code": "babel src --out-dir lib --ignore '**/*.test.ts' --extensions '.ts' && find ./lib -name '*.test.d.ts' -delete",
+    "build:types": "tsc --emitDeclarationOnly --declaration --isolatedModules false --declarationDir lib",
+    "coverage": "yarn test --coverage",
+    "lint": "eslint . --ext .js,.ts,.json --fix",
+    "lint:ci": "eslint . --ext .js,.ts,.json",
+    "prepack": "yarn build",
+    "test": "jest src --runInBand",
+    "type-check": "tsc --noEmit",
+    "type-check:watch": "npm run type-check -- --watch"
+  },
+  "lint-staged": {
+    "*.{html,md,yml}": [
+      "prettier --write"
+    ],
+    "*.{js,ts,json}": [
+      "eslint --fix"
+    ]
+  },
+  "babel": {
+    "extends": "@shelf/babel-config/backend"
+  },
+  "prettier": "@shelf/prettier-config",
+  "dependencies": {
+    "cwd": "0.10.0",
+    "debug": "4.3.4",
+    "postgres": "3.3.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "7.19.3",
+    "@babel/core": "7.20.2",
+    "@shelf/babel-config": "1.2.0",
+    "@shelf/eslint-config": "2.16.0",
+    "@shelf/prettier-config": "1.0.0",
+    "@shelf/tsconfig": "0.0.9",
+    "@types/cwd": "0.10.0",
+    "@types/debug": "4.1.7",
+    "@types/jest": "29.2.3",
+    "@types/js-yaml": "4.0.5",
+    "@types/node": "16",
+    "babel-jest": "29.3.1",
+    "eslint": "8.28.0",
+    "husky": "8.0.2",
+    "jest": "29.3.1",
+    "lint-staged": "13.0.3",
+    "prettier": "2.7.1",
+    "typescript": "4.9.3"
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

renovate.json

@@ -0,0 +1,8 @@
+{
+  "extends": ["config:base"],
+  "labels": ["dependencies", "backend"],
+  "ignoreDeps": [
+    "cimg/node",
+    "@types/node"
+  ]
+}

src/index.test.ts

@@ -0,0 +1,65 @@
+jest.setTimeout(10 * 60 * 1000);
+import cwd from 'cwd';
+import postgres from 'postgres';
+import {start, stop} from '.';
+
+describe('#postgres', () => {
+  it('should start postgres@14 locally', async () => {
+    const returnedUrl = await start({seedPath: `${cwd()}/src/schema.sql`});
+
+    const sql = postgres('postgres://localhost:5432/postgres');
+
+    const data = await sql`
+      SELECT attname, format_type(atttypid, atttypmod)
+      FROM pg_catalog.pg_attribute
+      WHERE attrelid = 'test.model1'::regclass
+      AND attnum > 0
+      AND NOT attisdropped;
+    `;
+
+    expect(data).toEqual([
+      {
+        attname: 'id',
+        format_type: 'character varying(36)',
+      },
+      {
+        attname: 'type',
+        format_type: 'text',
+      },
+      {
+        attname: 'text',
+        format_type: 'text',
+      },
+      {
+        attname: 'vector',
+        format_type: 'double precision[]',
+      },
+      {
+        attname: 'json',
+        format_type: 'jsonb',
+      },
+      {
+        attname: 'updated_at',
+        format_type: 'timestamp without time zone',
+      },
+      {
+        attname: 'somebool',
+        format_type: 'boolean',
+      },
+    ]);
+
+    expect(returnedUrl).toEqual('postgres://localhost:5432/postgres');
+  });
+
+  it('should stop postgres@14 locally', async () => {
+    await stop();
+    try {
+      const sql = postgres('postgres://localhost:5432/postgres');
+
+      await sql`create schema supertest`;
+    } catch (e) {
+      // @ts-ignore
+      expect(e.name).toEqual('Error');
+    }
+  });
+});

src/index.ts

@@ -0,0 +1,71 @@
+import getDebug from 'debug';
+import {exec} from 'child_process';
+import postgres from 'postgres';
+import {promisify} from 'util';
+
+const asyncExec = promisify(exec);
+import cwd from 'cwd';
+import {platform} from 'os';
+
+const debug = getDebug('postgres-local');
+const FILEPATH_PREFIX = `${cwd()}/node_modules/.cache/@shelf/postgres-local`;
+
+type StartESOptions = {
+  seedPath?: string;
+  version?: string;
+};
+
+export async function start(options: StartESOptions): Promise<string> {
+  const {seedPath, version = '14'} = options;
+
+  const url = 'postgres://localhost:5432/postgres';
+
+  try {
+    await asyncExec(`
+          ${getInstallationScript(version)}
+          mkdir ${FILEPATH_PREFIX}/data;
+          initdb -D ${FILEPATH_PREFIX}/data;
+          pg_ctl -D ${FILEPATH_PREFIX}/data -l logfile start;
+        `);
+
+    debug('Connecting to postgres...');
+    const sql = postgres(url);
+    debug('Postgres available!');
+    process.env.PSQL = url;
+
+    if (seedPath?.length) {
+      debug('Found seed file, seeding...');
+      await sql.file(seedPath);
+      debug('Seed done available!');
+    }
+
+    return url;
+  } catch (e) {
+    console.error(e);
+    throw e;
+  }
+}
+
+export async function stop(): Promise<{stdout: string; stderr: string}> {
+  return asyncExec(`
+      pg_ctl stop -D ${FILEPATH_PREFIX}/data
+      rm -rf ${FILEPATH_PREFIX}
+  `);
+}
+
+export function getInstallationScript(version: string): string {
+  switch (platform()) {
+    case 'darwin': {
+      return `brew install postgresql@${version}`;
+    }
+    case 'win32': {
+      throw new Error('Unsupported OS, try run on OS X or Linux');
+    }
+    default: {
+      return `
+        apt-get update
+        apt-get install -y postgresql-${version}
+      `;
+    }
+  }
+}