Skip to content
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

add detail status handler, small refactor #395

Merged
merged 5 commits into from
Apr 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/@types/OceanNode.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Stream } from 'stream'
import { RPCS } from './blockchain'
import { C2DClusterInfo } from './C2D'
import { FeeStrategy } from './Fees'
import { Schema } from '../components/database/schemas'

export interface OceanNodeDBConfig {
url: string | null
Expand Down Expand Up @@ -101,6 +102,9 @@ export interface OceanNodeStatus {
uptime?: number // seconds since start
codeHash?: string
allowedAdmins?: string[]
// detailed information
c2dClusters?: C2DClusterInfo[]
supportedSchemas?: Schema[]
}

export interface P2PBroadcastResponse {
Expand Down
1 change: 1 addition & 0 deletions src/@types/commands.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export interface ValidateDDOCommand extends Command {
}

export interface StatusCommand extends Command {}
export interface DetailedStatusCommand extends StatusCommand {}
export interface EchoCommand extends Command {}

export interface StopNodeCommand extends Command {
Expand Down
7 changes: 3 additions & 4 deletions src/components/core/compute/environments.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import { getConfiguration } from '../../../utils/config.js'
import { C2DEngine } from '../../c2d/compute_engines.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'
Expand All @@ -28,9 +27,9 @@ export class ComputeGetEnvironmentsHandler extends Handler {
}

async handle(task: ComputeGetEnvironmentsCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
const response: ComputeEnvironment[] = []
Expand Down
7 changes: 3 additions & 4 deletions src/components/core/compute/getResults.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import { ComputeGetResultCommand } from '../../../@types/commands.js'
import { C2DEngine } from '../../c2d/compute_engines.js'
import { checkNonce, NonceResponse } from '../utils/nonceHandler.js'
import {
buildInvalidParametersResponse,
buildInvalidRequestMessage,
validateCommandParameters,
ValidateParams
Expand Down Expand Up @@ -35,9 +34,9 @@ export class ComputeGetResultHandler extends Handler {
}

async handle(task: ComputeGetResultCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}

let error = null
Expand Down
7 changes: 3 additions & 4 deletions src/components/core/compute/getStatus.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import { getConfiguration } from '../../../utils/config.js'
import { C2DEngine } from '../../c2d/compute_engines.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'
Expand All @@ -32,9 +31,9 @@ export class ComputeGetStatusHandler extends Handler {
}

async handle(task: ComputeGetStatusCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
const response: ComputeJob[] = []
Expand Down
7 changes: 3 additions & 4 deletions src/components/core/compute/initialize.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ import { EncryptMethod } from '../../../@types/fileObject.js'
import { decrypt } from '../../../utils/crypt.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'
Expand Down Expand Up @@ -50,9 +49,9 @@ export class ComputeInitializeHandler extends Handler {
}

async handle(task: ComputeInitializeCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}

try {
Expand Down
7 changes: 3 additions & 4 deletions src/components/core/compute/startCompute.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import { ComputeStartCommand } from '../../../@types/commands.js'
import { C2DEngine } from '../../c2d/compute_engines.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'
Expand Down Expand Up @@ -41,9 +40,9 @@ export class ComputeStartHandler extends Handler {
}

async handle(task: ComputeStartCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
// split compute env (which is already in hash-envId format) and get the hash
Expand Down
7 changes: 3 additions & 4 deletions src/components/core/compute/stopCompute.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import { ComputeStopCommand } from '../../../@types/commands.js'
import { C2DEngine } from '../../c2d/compute_engines.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'
Expand All @@ -31,9 +30,9 @@ export class ComputeStopHandler extends Handler {
}

async handle(task: ComputeStopCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
// split jobId (which is already in hash-jobId format) and get the hash
Expand Down
6 changes: 5 additions & 1 deletion src/components/core/handler/coreHandlersRegistry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { FeesHandler } from './feesHandler.js'
import { Handler } from './handler.js'
import { NonceHandler } from './nonceHandler.js'
import { QueryHandler } from './queryHandler.js'
import { StatusHandler } from './statusHandler.js'
import { DetailedStatusHandler, StatusHandler } from './statusHandler.js'
import { ReindexHandler } from './reindexHandler.js'
import { OceanNode } from '../../../OceanNode.js'
import { Command } from '../../../@types/commands.js'
Expand Down Expand Up @@ -75,6 +75,10 @@ export class CoreHandlersRegistry {
this.registerCoreHandler(PROTOCOL_COMMANDS.GET_DDO, new GetDdoHandler(node))
this.registerCoreHandler(PROTOCOL_COMMANDS.QUERY, new QueryHandler(node))
this.registerCoreHandler(PROTOCOL_COMMANDS.STATUS, new StatusHandler(node))
this.registerCoreHandler(
PROTOCOL_COMMANDS.DETAILED_STATUS,
new DetailedStatusHandler(node)
)
this.registerCoreHandler(PROTOCOL_COMMANDS.FIND_DDO, new FindDdoHandler(node))
this.registerCoreHandler(PROTOCOL_COMMANDS.GET_FEES, new FeesHandler(node))
this.registerCoreHandler(PROTOCOL_COMMANDS.ECHO, new EchoHandler(node))
Expand Down
36 changes: 12 additions & 24 deletions src/components/core/handler/ddoHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,7 @@
import { EncryptMethod } from '../../../@types/fileObject.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
buildRateLimitReachedResponse,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'
import {
Expand Down Expand Up @@ -67,11 +65,10 @@
}

async handle(task: DecryptDDOCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}

try {
let decrypterAddress: string
try {
Expand Down Expand Up @@ -217,7 +214,7 @@
try {
encryptedDocument = ethers.getBytes(task.encryptedDocument)
flags = Number(task.flags)
documentHash = task.documentHash

Check warning on line 217 in src/components/core/handler/ddoHandler.ts

View workflow job for this annotation

GitHub Actions / lint

Use object destructuring
} catch (error) {
CORE_LOGGER.logMessage(`Decrypt DDO: error ${error}`, true)
return {
Expand Down Expand Up @@ -383,9 +380,9 @@
}

async handle(task: GetDdoCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
const ddo = await this.getOceanNode().getDatabase().ddo.retrieve(task.id)
Expand Down Expand Up @@ -419,9 +416,9 @@
}

async handle(task: FindDDOCommand): Promise<P2PCommandResponse> {
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
const node = this.getOceanNode()
Expand Down Expand Up @@ -734,18 +731,9 @@
}

async handle(task: ValidateDDOCommand): Promise<P2PCommandResponse> {
if (!(await this.checkRateLimit())) {
return buildRateLimitReachedResponse()
}
const commandValidation = this.validate(task)
if (!commandValidation.valid) {
return {
stream: null,
status: {
httpStatus: commandValidation.status,
error: `Validation error: ${commandValidation.reason}`
}
}
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
const validation = await validateObject(
Expand Down
11 changes: 3 additions & 8 deletions src/components/core/handler/downloadHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ import { DownloadCommand, DownloadURLCommand } from '../../../@types/commands.js
import { EncryptMethod } from '../../../@types/fileObject.js'
import { C2DEngine } from '../../c2d/compute_engines.js'
import {
buildInvalidParametersResponse,
buildRateLimitReachedResponse,
validateCommandParameters,
ValidateParams
} from '../../httpRoutes/validateCommands.js'
Expand Down Expand Up @@ -178,12 +176,9 @@ export class DownloadHandler extends Handler {
// No encryption here yet

async handle(task: DownloadCommand): Promise<P2PCommandResponse> {
if (!(await this.checkRateLimit())) {
return buildRateLimitReachedResponse()
}
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
const node = this.getOceanNode()
// 1. Get the DDO
Expand Down
13 changes: 6 additions & 7 deletions src/components/core/handler/echoHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { P2PCommandResponse } from '../../../@types/index.js'
import { EchoCommand } from '../../../@types/commands.js'
import { ReadableString } from '../../P2P/handleProtocolCommands.js'
import {
buildRateLimitReachedResponse,
validateCommandParameters,
ValidateParams
} from '../../httpRoutes/validateCommands.js'
Expand All @@ -14,16 +13,16 @@ export class EchoHandler extends Handler {
}

async handle(task: EchoCommand): Promise<P2PCommandResponse> {
if (!(await this.checkRateLimit())) {
return buildRateLimitReachedResponse()
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
const validation = this.validate(task)
return {
status: {
httpStatus: validation.valid ? 200 : validation.status,
error: validation.valid ? '' : validation.reason
httpStatus: 200,
error: null
},
stream: validation.valid ? new ReadableString('OK') : null
stream: new ReadableString('OK')
}
}
}
20 changes: 6 additions & 14 deletions src/components/core/handler/encryptHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ import { getConfiguration } from '../../../utils/index.js'
import { EncryptMethod } from '../../../@types/fileObject.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
buildRateLimitReachedResponse,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'

Expand Down Expand Up @@ -50,12 +48,9 @@ export class EncryptHandler extends Handler {
}

async handle(task: EncryptCommand): Promise<P2PCommandResponse> {
if (!(await this.checkRateLimit())) {
return buildRateLimitReachedResponse()
}
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
// prepare an empty array in case if
Expand Down Expand Up @@ -109,12 +104,9 @@ export class EncryptFileHandler extends Handler {
}

async handle(task: EncryptFileCommand): Promise<P2PCommandResponse> {
if (!(await this.checkRateLimit())) {
return buildRateLimitReachedResponse()
}
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
const config = await getConfiguration()
Expand Down
11 changes: 3 additions & 8 deletions src/components/core/handler/feesHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ import { GENERIC_EMOJIS, LOG_LEVELS_STR } from '../../../utils/logging/Logger.js
import { PROVIDER_LOGGER } from '../../../utils/logging/common.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
buildRateLimitReachedResponse,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'
import { validateDDOIdentifier } from './ddoHandler.js'
Expand All @@ -31,12 +29,9 @@ export class FeesHandler extends Handler {
}

async handle(task: GetFeesCommand): Promise<P2PCommandResponse> {
if (!(await this.checkRateLimit())) {
return buildRateLimitReachedResponse()
}
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
PROVIDER_LOGGER.logMessage(
`Try to calculate fees for DDO with id: ${task.ddoId} and serviceId: ${task.serviceId}`,
Expand Down
11 changes: 3 additions & 8 deletions src/components/core/handler/fileInfoHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ import { AssetUtils, fetchFileMetadata } from '../../../utils/asset.js'
import { OceanNode } from '../../../OceanNode.js'
import {
ValidateParams,
buildInvalidParametersResponse,
buildInvalidRequestMessage,
buildRateLimitReachedResponse,
validateCommandParameters
} from '../../httpRoutes/validateCommands.js'

Expand Down Expand Up @@ -110,12 +108,9 @@ export class FileInfoHandler extends Handler {
}

async handle(task: FileInfoCommand): Promise<P2PCommandResponse> {
if (!(await this.checkRateLimit())) {
return buildRateLimitReachedResponse()
}
const validation = this.validate(task)
if (!validation.valid) {
return buildInvalidParametersResponse(validation)
const validationResponse = await this.verifyParamsAndRateLimits(task)
if (this.shouldDenyTaskHandling(validationResponse)) {
return validationResponse
}
try {
const oceanNode = this.getOceanNode()
Expand Down
Loading
Loading