-
Notifications
You must be signed in to change notification settings - Fork 47.4k
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
[Flight] Add rudimentary PG binding #20372
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# react-pg | ||
|
||
This package is meant to be used alongside yet-to-be-released, experimental React features. It's unlikely to be useful in any other context. | ||
|
||
**Do not use in a real application.** We're publishing this early for | ||
demonstration purposes. | ||
|
||
**Use it at your own risk.** | ||
|
||
# No, Really, It Is Unstable | ||
|
||
The API ~~may~~ will change wildly between versions. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
* @flow | ||
*/ | ||
|
||
throw new Error( | ||
'This entry point is not yet supported in the browser environment', | ||
); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
* @flow | ||
*/ | ||
|
||
'use strict'; | ||
|
||
export * from './index.node'; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
* @flow | ||
*/ | ||
|
||
'use strict'; | ||
|
||
export * from './src/ReactPostgres'; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
'use strict'; | ||
|
||
if (process.env.NODE_ENV === 'production') { | ||
module.exports = require('./cjs/react-pg.browser.production.min.js'); | ||
} else { | ||
module.exports = require('./cjs/react-pg.browser.development.js'); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
'use strict'; | ||
|
||
module.exports = require('./index.node'); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
'use strict'; | ||
|
||
if (process.env.NODE_ENV === 'production') { | ||
module.exports = require('./cjs/react-pg.node.production.min.js'); | ||
} else { | ||
module.exports = require('./cjs/react-pg.node.development.js'); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
{ | ||
"private": true, | ||
"name": "react-pg", | ||
"description": "React bindings for PostgreSQL", | ||
"version": "0.0.0", | ||
"repository": { | ||
"type" : "git", | ||
"url" : "https://github.com/facebook/react.git", | ||
"directory": "packages/react-pg" | ||
}, | ||
"files": [ | ||
"LICENSE", | ||
"README.md", | ||
"build-info.json", | ||
"index.js", | ||
"index.node.js", | ||
"index.browser.js", | ||
"cjs/" | ||
], | ||
"peerDependencies": { | ||
"react": "^17.0.0", | ||
"pg": "*" | ||
}, | ||
"browser": { | ||
"./index.js": "./index.browser.js" | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
/** | ||
* Copyright (c) Facebook, Inc. and its affiliates. | ||
* | ||
* This source code is licensed under the MIT license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
* | ||
* @flow | ||
*/ | ||
|
||
import type {Wakeable} from 'shared/ReactTypes'; | ||
|
||
import {unstable_getCacheForType} from 'react'; | ||
import {Pool as PostgresPool} from 'pg'; | ||
import {prepareValue} from 'pg/lib/utils'; | ||
|
||
const Pending = 0; | ||
const Resolved = 1; | ||
const Rejected = 2; | ||
|
||
type PendingResult = {| | ||
status: 0, | ||
value: Wakeable, | ||
|}; | ||
|
||
type ResolvedResult = {| | ||
status: 1, | ||
value: mixed, | ||
|}; | ||
|
||
type RejectedResult = {| | ||
status: 2, | ||
value: mixed, | ||
|}; | ||
|
||
type Result = PendingResult | ResolvedResult | RejectedResult; | ||
|
||
function toResult(thenable): Result { | ||
const result: Result = { | ||
status: Pending, | ||
value: thenable, | ||
}; | ||
thenable.then( | ||
value => { | ||
if (result.status === Pending) { | ||
const resolvedResult = ((result: any): ResolvedResult); | ||
resolvedResult.status = Resolved; | ||
resolvedResult.value = value; | ||
} | ||
}, | ||
err => { | ||
if (result.status === Pending) { | ||
const rejectedResult = ((result: any): RejectedResult); | ||
rejectedResult.status = Rejected; | ||
rejectedResult.value = err; | ||
} | ||
}, | ||
); | ||
return result; | ||
} | ||
|
||
function readResult(result: Result) { | ||
if (result.status === Resolved) { | ||
return result.value; | ||
} else { | ||
throw result.value; | ||
} | ||
} | ||
|
||
export function Pool(options: mixed) { | ||
this.pool = new PostgresPool(options); | ||
// Unique function per instance because it's used for cache identity. | ||
this.createResultMap = function() { | ||
return new Map(); | ||
}; | ||
} | ||
|
||
Pool.prototype.query = function(query: string, values?: Array<mixed>) { | ||
const pool = this.pool; | ||
const outerMap = unstable_getCacheForType(this.createResultMap); | ||
|
||
let innerMap: Map<any, any> = outerMap; | ||
let key = query; | ||
if (values != null) { | ||
// If we have parameters, each becomes as a nesting layer for Maps. | ||
// We want to find (or create as needed) the innermost Map, and return that. | ||
for (let i = 0; i < values.length; i++) { | ||
let nextMap = innerMap.get(key); | ||
if (nextMap === undefined) { | ||
nextMap = new Map(); | ||
innerMap.set(key, nextMap); | ||
} | ||
innerMap = nextMap; | ||
// Postgres bindings convert everything to strings: | ||
// https://node-postgres.com/features/queries#parameterized-query | ||
// We reuse their algorithm instead of reimplementing. | ||
key = prepareValue(values[i]); | ||
} | ||
} | ||
|
||
let entry: Result | void = innerMap.get(key); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So this value might not be a Map in case the same query string was used with different number of params. Since the string should use exactly all params, this is an error case. Hopefully, PG errors in that case. But if it was the correct number of arguments first and then the wrong number of arguments later, then it would throw an error down below where you try to call One approach would be to check |
||
if (!entry) { | ||
const thenable = pool.query(query, values); | ||
gaearon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
entry = toResult(thenable); | ||
innerMap.set(key, entry); | ||
} | ||
return readResult(entry); | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can return a Result or a Map.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm assuming that for the same query, you always have the same number of parameters. So this would not be a Result in practice. What scenario are you thinking of?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK the early error makes sense.