archive-gh-me/node-postgres
1
0
Fork 0
mirror of https://github.com/brianc/node-postgres.git synced 2025-12-08 20:16:25 +00:00
Code Issues Projects Releases Wiki Activity

[pg-protocol] use literals instead of const enum (#2490)

Browse Source 
Co-authored-by: Emily Marigold Klassen <forivall@users.noreply.github.com>
This commit is contained in:
Emily Marigold Klassen 2021-03-12 09:01:51 -08:00 committed by GitHub
parent 69af1cc934
commit 45fa27ea4a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 56 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
packages/pg-protocol/src/messages.ts
View File

@ -1,33 +1,32 @@
export type Mode = 'text' | 'binary'
export const enum MessageName {
parseComplete = 'parseComplete',
bindComplete = 'bindComplete',
closeComplete = 'closeComplete',
noData = 'noData',
portalSuspended = 'portalSuspended',
replicationStart = 'replicationStart',
emptyQuery = 'emptyQuery',
copyDone = 'copyDone',
copyData = 'copyData',
rowDescription = 'rowDescription',
parameterStatus = 'parameterStatus',
backendKeyData = 'backendKeyData',
notification = 'notification',
readyForQuery = 'readyForQuery',
commandComplete = 'commandComplete',
dataRow = 'dataRow',
copyInResponse = 'copyInResponse',
copyOutResponse = 'copyOutResponse',
authenticationOk = 'authenticationOk',
authenticationMD5Password = 'authenticationMD5Password',
authenticationCleartextPassword = 'authenticationCleartextPassword',
authenticationSASL = 'authenticationSASL',
authenticationSASLContinue = 'authenticationSASLContinue',
authenticationSASLFinal = 'authenticationSASLFinal',
error = 'error',
notice = 'notice',
}
export type MessageName =
| 'parseComplete'
| 'bindComplete'
| 'closeComplete'
| 'noData'
| 'portalSuspended'
| 'replicationStart'
| 'emptyQuery'
| 'copyDone'
| 'copyData'
| 'rowDescription'
| 'parameterStatus'
| 'backendKeyData'
| 'notification'
| 'readyForQuery'
| 'commandComplete'
| 'dataRow'
| 'copyInResponse'
| 'copyOutResponse'
| 'authenticationOk'
| 'authenticationMD5Password'
| 'authenticationCleartextPassword'
| 'authenticationSASL'
| 'authenticationSASLContinue'
| 'authenticationSASLFinal'
| 'error'
| 'notice'
export interface BackendMessage {
name: MessageName
@ -35,42 +34,42 @@ export interface BackendMessage {
}
export const parseComplete: BackendMessage = {
name: MessageName.parseComplete,
name: 'parseComplete',
length: 5,
}
export const bindComplete: BackendMessage = {
name: MessageName.bindComplete,
name: 'bindComplete',
length: 5,
}
export const closeComplete: BackendMessage = {
name: MessageName.closeComplete,
name: 'closeComplete',
length: 5,
}
export const noData: BackendMessage = {
name: MessageName.noData,
name: 'noData',
length: 5,
}
export const portalSuspended: BackendMessage = {
name: MessageName.portalSuspended,
name: 'portalSuspended',
length: 5,
}
export const replicationStart: BackendMessage = {
name: MessageName.replicationStart,
name: 'replicationStart',
length: 4,
}
export const emptyQuery: BackendMessage = {
name: MessageName.emptyQuery,
name: 'emptyQuery',
length: 4,
}
export const copyDone: BackendMessage = {
name: MessageName.copyDone,
name: 'copyDone',
length: 4,
}
@ -117,7 +116,7 @@ export class DatabaseError extends Error implements NoticeOrError {
}
export class CopyDataMessage {
public readonly name = MessageName.copyData
public readonly name = 'copyData'
constructor(public readonly length: number, public readonly chunk: Buffer) {}
}
@ -146,7 +145,7 @@ export class Field {
}
export class RowDescriptionMessage {
public readonly name: MessageName = MessageName.rowDescription
public readonly name: MessageName = 'rowDescription'
public readonly fields: Field[]
constructor(public readonly length: number, public readonly fieldCount: number) {
this.fields = new Array(this.fieldCount)
@ -154,7 +153,7 @@ export class RowDescriptionMessage {
}
export class ParameterStatusMessage {
public readonly name: MessageName = MessageName.parameterStatus
public readonly name: MessageName = 'parameterStatus'
constructor(
public readonly length: number,
public readonly parameterName: string,
@ -163,17 +162,17 @@ export class ParameterStatusMessage {
}
export class AuthenticationMD5Password implements BackendMessage {
public readonly name: MessageName = MessageName.authenticationMD5Password
public readonly name: MessageName = 'authenticationMD5Password'
constructor(public readonly length: number, public readonly salt: Buffer) {}
}
export class BackendKeyDataMessage {
public readonly name: MessageName = MessageName.backendKeyData
public readonly name: MessageName = 'backendKeyData'
constructor(public readonly length: number, public readonly processID: number, public readonly secretKey: number) {}
}
export class NotificationResponseMessage {
public readonly name: MessageName = MessageName.notification
public readonly name: MessageName = 'notification'
constructor(
public readonly length: number,
public readonly processId: number,
@ -183,18 +182,18 @@ export class NotificationResponseMessage {
}
export class ReadyForQueryMessage {
public readonly name: MessageName = MessageName.readyForQuery
public readonly name: MessageName = 'readyForQuery'
constructor(public readonly length: number, public readonly status: string) {}
}
export class CommandCompleteMessage {
public readonly name: MessageName = MessageName.commandComplete
public readonly name: MessageName = 'commandComplete'
constructor(public readonly length: number, public readonly text: string) {}
}
export class DataRowMessage {
public readonly fieldCount: number
public readonly name: MessageName = MessageName.dataRow
public readonly name: MessageName = 'dataRow'
constructor(public length: number, public fields: any[]) {
this.fieldCount = fields.length
}
@ -202,7 +201,7 @@ export class DataRowMessage {
export class NoticeMessage implements BackendMessage, NoticeOrError {
constructor(public readonly length: number, public readonly message: string | undefined) {}
public readonly name = MessageName.notice
public readonly name = 'notice'
public severity: string | undefined
public code: string | undefined
public detail: string | undefined

24
packages/pg-protocol/src/parser.ts
View File

@ -183,9 +183,9 @@ export class Parser {
case MessageCodes.BackendKeyData:
return this.parseBackendKeyData(offset, length, bytes)
case MessageCodes.ErrorMessage:
return this.parseErrorMessage(offset, length, bytes, MessageName.error)
return this.parseErrorMessage(offset, length, bytes, 'error')
case MessageCodes.NoticeMessage:
return this.parseErrorMessage(offset, length, bytes, MessageName.notice)
return this.parseErrorMessage(offset, length, bytes, 'notice')
case MessageCodes.RowDescriptionMessage:
return this.parseRowDescriptionMessage(offset, length, bytes)
case MessageCodes.CopyIn:
@ -217,11 +217,11 @@ export class Parser {
}
private parseCopyInMessage(offset: number, length: number, bytes: Buffer) {
return this.parseCopyMessage(offset, length, bytes, MessageName.copyInResponse)
return this.parseCopyMessage(offset, length, bytes, 'copyInResponse')
}
private parseCopyOutMessage(offset: number, length: number, bytes: Buffer) {
return this.parseCopyMessage(offset, length, bytes, MessageName.copyOutResponse)
return this.parseCopyMessage(offset, length, bytes, 'copyOutResponse')
}
private parseCopyMessage(offset: number, length: number, bytes: Buffer, messageName: MessageName) {
@ -295,7 +295,7 @@ export class Parser {
const code = this.reader.int32()
// TODO(bmc): maybe better types here
const message: BackendMessage & any = {
name: MessageName.authenticationOk,
name: 'authenticationOk',
length,
}
@ -304,18 +304,18 @@ export class Parser {
break
case 3: // AuthenticationCleartextPassword
if (message.length === 8) {
message.name = MessageName.authenticationCleartextPassword
message.name = 'authenticationCleartextPassword'
}
break
case 5: // AuthenticationMD5Password
if (message.length === 12) {
message.name = MessageName.authenticationMD5Password
message.name = 'authenticationMD5Password'
const salt = this.reader.bytes(4)
return new AuthenticationMD5Password(length, salt)
}
break
case 10: // AuthenticationSASL
message.name = MessageName.authenticationSASL
message.name = 'authenticationSASL'
message.mechanisms = []
let mechanism: string
do {
@ -327,11 +327,11 @@ export class Parser {
} while (mechanism)
break
case 11: // AuthenticationSASLContinue
message.name = MessageName.authenticationSASLContinue
message.name = 'authenticationSASLContinue'
message.data = this.reader.string(length - 8)
break
case 12: // AuthenticationSASLFinal
message.name = MessageName.authenticationSASLFinal
message.name = 'authenticationSASLFinal'
message.data = this.reader.string(length - 8)
break
default:
@ -352,9 +352,7 @@ export class Parser {
const messageValue = fields.M
const message =
name === MessageName.notice
? new NoticeMessage(length, messageValue)
: new DatabaseError(messageValue, length, name)
name === 'notice' ? new NoticeMessage(length, messageValue) : new DatabaseError(messageValue, length, name)
message.severity = fields.S
message.code = fields.C