feast/sdk/python/feast/offline_server.py at apply-progress · feast-dev/feast · GitHub

History

623 lines (549 loc) · 23.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

import ast

import json

import logging

import os

import sys

import traceback

from datetime import datetime

from typing import Any, Dict, List, Optional, cast

import click

import pyarrow as pa

import pyarrow.flight as fl

from google.protobuf.json_format import Parse

from feast import FeatureStore, FeatureView, utils

from feast.arrow_error_handler import arrow_server_error_handling_decorator

from feast.data_source import DataSource

from feast.feature_logging import FeatureServiceLoggingSource

from feast.feature_view import DUMMY_ENTITY_NAME

from feast.infra.offline_stores.offline_utils import get_offline_store_from_config

from feast.permissions.action import AuthzedAction

from feast.permissions.security_manager import assert_permissions

from feast.permissions.server.arrow import (

AuthorizationMiddlewareFactory,

inject_user_details_decorator,

)

from feast.permissions.server.utils import (

AuthManagerType,

ServerType,

init_auth_manager,

init_security_manager,

str_to_auth_manager_type,

)

from feast.protos.feast.core.DataSource_pb2 import DataSource as DataSourceProto

from feast.saved_dataset import SavedDatasetStorage

logger = logging.getLogger(__name__)

logger.setLevel(logging.INFO)

class OfflineServer(fl.FlightServerBase):

def __init__(

self,

store: FeatureStore,

location: str,

host: str = "localhost",

tls_certificates: List = [],

**kwargs,

super(OfflineServer, self).__init__(

location=location,

middleware=self.arrow_flight_auth_middleware(

str_to_auth_manager_type(store.config.auth_config.type)

tls_certificates=tls_certificates,

verify_client=False, # this is needed for when we don't need mTLS

**kwargs,

)

self._location = location

# A dictionary of configured flights, e.g. API calls received and not yet served

self.flights: Dict[str, Any] = {}

self.store = store

self.offline_store = get_offline_store_from_config(store.config.offline_store)

self.host = host

self.tls_certificates = tls_certificates

def arrow_flight_auth_middleware(

self,

auth_type: AuthManagerType,

) -> dict[str, fl.ServerMiddlewareFactory]:

"""

A dictionary with the configured middlewares to support extracting the user details when the authorization manager is defined.

The authorization middleware key is `auth`.

Returns:

dict[str, fl.ServerMiddlewareFactory]: Optional dictionary of middlewares. If the authorization type is set to `NONE`, it returns an empty dict.

"""

if auth_type == AuthManagerType.NONE:

return {}

return {

"auth": AuthorizationMiddlewareFactory(),

}

@classmethod

def descriptor_to_key(self, descriptor: fl.FlightDescriptor):

return (

descriptor.descriptor_type.value,

descriptor.command,

tuple(descriptor.path or tuple()),

)

def _make_flight_info(self, key: Any, descriptor: fl.FlightDescriptor):

if len(self.tls_certificates) != 0:

location = fl.Location.for_grpc_tls(self.host, self.port)

else:

location = fl.Location.for_grpc_tcp(self.host, self.port)

endpoints = [

fl.FlightEndpoint(repr(key), [location]),

]

schema = pa.schema([])

return fl.FlightInfo(schema, descriptor, endpoints, -1, -1)

@inject_user_details_decorator

@arrow_server_error_handling_decorator

def list_flights(self, context: fl.ServerCallContext, criteria: bytes):

for key, table in self.flights.items():

if key[1] is not None:

descriptor = fl.FlightDescriptor.for_command(key[1])

else:

descriptor = fl.FlightDescriptor.for_path(*key[2])

yield self._make_flight_info(key, descriptor)

@inject_user_details_decorator

@arrow_server_error_handling_decorator

def get_flight_info(

self, context: fl.ServerCallContext, descriptor: fl.FlightDescriptor

key = OfflineServer.descriptor_to_key(descriptor)

if key in self.flights:

return self._make_flight_info(key, descriptor)

raise KeyError("Flight not found.")

# Expects to receive request parameters and stores them in the flights dictionary

# Indexed by the unique command

@inject_user_details_decorator

@arrow_server_error_handling_decorator

def do_put(

self,

context: fl.ServerCallContext,

descriptor: fl.FlightDescriptor,

reader: fl.MetadataRecordBatchReader,

writer: fl.FlightMetadataWriter,

key = OfflineServer.descriptor_to_key(descriptor)

command = json.loads(key[1])

if "api" in command:

data = reader.read_all()

logger.debug(f"do_put: command is{command}, data is {data}")

self.flights[key] = data

self._call_api(command["api"], command, key)

else:

logger.warning(f"No 'api' field in command: {command}")

def _call_api(self, api: str, command: dict, key: str):

assert api is not None, "api can not be empty"

remove_data = False

try:

if api == OfflineServer.offline_write_batch.__name__:

self.offline_write_batch(command, key)

remove_data = True

elif api == OfflineServer.write_logged_features.__name__:

self.write_logged_features(command, key)

remove_data = True

elif api == OfflineServer.persist.__name__:

self.persist(command, key)

remove_data = True

elif api == OfflineServer.validate_data_source.__name__:

self.validate_data_source(command)

remove_data = True

except Exception as e:

remove_data = True

logger.exception(e)

traceback.print_exc()

raise e

finally:

if remove_data:

# Get service is consumed, so we clear the corresponding flight and data

del self.flights[key]

def get_feature_view_by_name(

self, fv_name: str, name_alias: str, project: str

) -> FeatureView:

"""

Retrieves a feature view by name, including all subclasses of FeatureView.

Args:

fv_name: Name of feature view

name_alias: Alias to be applied to the projection of the registered view

project: Feast project that this feature view belongs to

Returns:

Returns either the specified feature view, or raises an exception if

none is found

"""

try:

fv = self.store.registry.get_feature_view(name=fv_name, project=project)

if name_alias is not None:

for fs in self.store.registry.list_feature_services(project=project):

for p in fs.feature_view_projections:

if p.name_alias == name_alias:

logger.debug(

f"Found matching FeatureService {fs.name} with projection {p}"

)

fv = fv.with_projection(p)

return fv

except Exception:

try:

return self.store.registry.get_stream_feature_view(

name=fv_name, project=project

)

except Exception as e:

logger.error(

f"Cannot find any FeatureView by name {fv_name} in project {project}"

)

raise e

def list_feature_views_by_name(

self, feature_view_names: List[str], name_aliases: List[str], project: str

) -> List[FeatureView]:

return [

remove_dummies(

self.get_feature_view_by_name(

fv_name=fv_name, name_alias=name_aliases[index], project=project

)

for index, fv_name in enumerate(feature_view_names)

]

def _validate_do_get_parameters(self, command: dict):

assert "api" in command, "api parameter is mandatory"

# Extracts the API parameters from the flights dictionary, delegates the execution to the FeatureStore instance

# and returns the stream of data

@inject_user_details_decorator

@arrow_server_error_handling_decorator

def do_get(self, context: fl.ServerCallContext, ticket: fl.Ticket):

key = ast.literal_eval(ticket.ticket.decode())

if key not in self.flights:

logger.error(f"Unknown key {key}")

return None

command = json.loads(key[1])

self._validate_do_get_parameters(command)

api = command["api"]

logger.debug(f"get command is {command}")

logger.debug(f"requested api is {api}")

try:

if api == OfflineServer.get_historical_features.__name__:

table = self.get_historical_features(command, key).to_arrow()

elif api == OfflineServer.pull_all_from_table_or_query.__name__:

table = self.pull_all_from_table_or_query(command).to_arrow()

elif api == OfflineServer.pull_latest_from_table_or_query.__name__:

table = self.pull_latest_from_table_or_query(command).to_arrow()

elif (

api

== OfflineServer.get_table_column_names_and_types_from_data_source.__name__

table = self.get_table_column_names_and_types_from_data_source(command)

else:

raise NotImplementedError

except Exception as e:

logger.exception(e)

traceback.print_exc()

raise e

# Get service is consumed, so we clear the corresponding flight and data

del self.flights[key]

return fl.RecordBatchStream(table)

def _validate_offline_write_batch_parameters(self, command: dict):

assert "feature_view_names" in command, (

"feature_view_names is a mandatory parameter"

)

assert "name_aliases" in command, "name_aliases is a mandatory parameter"

feature_view_names = command["feature_view_names"]

assert len(feature_view_names) == 1, (

"feature_view_names list should only have one item"

)

name_aliases = command["name_aliases"]

assert len(name_aliases) == 1, "name_aliases list should only have one item"

def offline_write_batch(self, command: dict, key: str):

self._validate_offline_write_batch_parameters(command)

feature_view_names = command["feature_view_names"]

name_aliases = command["name_aliases"]

project = self.store.config.project

feature_views = self.list_feature_views_by_name(

feature_view_names=feature_view_names,

name_aliases=name_aliases,

project=project,

)

assert len(feature_views) == 1, "incorrect feature view"

table = self.flights[key]

self.offline_store.offline_write_batch(

self.store.config,

cast(

FeatureView,

assert_permissions(

feature_views[0], actions=[AuthzedAction.WRITE_OFFLINE]

table,

command["progress"],

)

def _validate_write_logged_features_parameters(self, command: dict):

assert "feature_service_name" in command

def write_logged_features(self, command: dict, key: str):

self._validate_write_logged_features_parameters(command)

table = self.flights[key]

feature_service = self.store.get_feature_service(

command["feature_service_name"]

)

assert feature_service.logging_config is not None, (

"feature service must have logging_config set"

)

assert_permissions(

resource=feature_service,

actions=[AuthzedAction.WRITE_OFFLINE],

)

self.offline_store.write_logged_features(

config=self.store.config,

data=table,

source=FeatureServiceLoggingSource(

feature_service, self.store.config.project

logging_config=feature_service.logging_config,

registry=self.store.registry,

)

def _validate_pull_all_from_table_or_query_parameters(self, command: dict):

assert "data_source_name" in command, (

"data_source_name is a mandatory parameter"

)

assert "join_key_columns" in command, (

"join_key_columns is a mandatory parameter"

)

assert "feature_name_columns" in command, (

"feature_name_columns is a mandatory parameter"

)

assert "timestamp_field" in command, "timestamp_field is a mandatory parameter"

assert "start_date" in command, "start_date is a mandatory parameter"

assert "end_date" in command, "end_date is a mandatory parameter"

def pull_all_from_table_or_query(self, command: dict):

self._validate_pull_all_from_table_or_query_parameters(command)

data_source = self.store.get_data_source(command["data_source_name"])

assert_permissions(data_source, actions=[AuthzedAction.READ_OFFLINE])

return self.offline_store.pull_all_from_table_or_query(

config=self.store.config,

data_source=data_source,

join_key_columns=command["join_key_columns"],

feature_name_columns=command["feature_name_columns"],

created_timestamp_column=command["created_timestamp_column"],

timestamp_field=command["timestamp_field"],

start_date=utils.make_tzaware(

datetime.fromisoformat(command["start_date"])

end_date=utils.make_tzaware(datetime.fromisoformat(command["end_date"])),

)

def _validate_pull_latest_from_table_or_query_parameters(self, command: dict):

assert "data_source_name" in command, (

"data_source_name is a mandatory parameter"

)

assert "join_key_columns" in command, (

"join_key_columns is a mandatory parameter"

)

assert "feature_name_columns" in command, (

"feature_name_columns is a mandatory parameter"

)

assert "timestamp_field" in command, "timestamp_field is a mandatory parameter"

assert "start_date" in command, "start_date is a mandatory parameter"

assert "end_date" in command, "end_date is a mandatory parameter"

def pull_latest_from_table_or_query(self, command: dict):

self._validate_pull_latest_from_table_or_query_parameters(command)

data_source = self.store.get_data_source(command["data_source_name"])

assert_permissions(resource=data_source, actions=[AuthzedAction.READ_OFFLINE])

return self.offline_store.pull_latest_from_table_or_query(

self.store.config,

data_source,

command["join_key_columns"],

command["feature_name_columns"],

command["timestamp_field"],

command["created_timestamp_column"],

utils.make_tzaware(datetime.fromisoformat(command["start_date"])),

utils.make_tzaware(datetime.fromisoformat(command["end_date"])),

)

@arrow_server_error_handling_decorator

def list_actions(self, context):

return [

(

OfflineServer.offline_write_batch.__name__,

"Writes the specified arrow table to the data source underlying the specified feature view.",

(

OfflineServer.write_logged_features.__name__,

"Writes logged features to a specified destination in the offline store.",

(

OfflineServer.persist.__name__,

"Synchronously executes the underlying query and persists the result in the same offline store at the "

"specified destination.",

]

def _validate_get_historical_features_parameters(

self, command: dict, key: Optional[str] = None

if key:

assert key in self.flights, f"missing key={key}"

assert "feature_view_names" in command, "feature_view_names is mandatory"

assert "name_aliases" in command, "name_aliases is mandatory"

assert "feature_refs" in command, "feature_refs is mandatory"

assert "project" in command, "project is mandatory"

assert "full_feature_names" in command, "full_feature_names is mandatory"

def get_historical_features(self, command: dict, key: Optional[str] = None):

self._validate_get_historical_features_parameters(command, key)

entity_df = None

if key:

# Extract parameters from the internal flights dictionary

entity_df_value = self.flights[key]

entity_df = pa.Table.to_pandas(entity_df_value)

# Check if this is a mock/empty table (contains only 'key' column)

if len(entity_df.columns) == 1 and "key" in entity_df.columns:

entity_df = None

feature_view_names = command["feature_view_names"]

name_aliases = command["name_aliases"]

feature_refs = command["feature_refs"]

project = command["project"]

full_feature_names = command["full_feature_names"]

feature_views = self.list_feature_views_by_name(

feature_view_names=feature_view_names,

name_aliases=name_aliases,

project=project,

)

for feature_view in feature_views:

assert_permissions(

resource=feature_view, actions=[AuthzedAction.READ_OFFLINE]

)

# Extract and deserialize start_date/end_date if present

kwargs = {}

if "start_date" in command and command["start_date"] is not None:

kwargs["start_date"] = utils.make_tzaware(

datetime.fromisoformat(command["start_date"])

)

if "end_date" in command and command["end_date"] is not None:

kwargs["end_date"] = utils.make_tzaware(

datetime.fromisoformat(command["end_date"])

)

retJob = self.offline_store.get_historical_features(

config=self.store.config,

feature_views=feature_views,

feature_refs=feature_refs,

entity_df=entity_df,

registry=self.store.registry,

project=project,

full_feature_names=full_feature_names,

**kwargs,

)

return retJob

def _validate_persist_parameters(self, command: dict):

assert "retrieve_func" in command, "retrieve_func is mandatory"

assert "data_source_name" in command, "data_source_name is mandatory"

assert "allow_overwrite" in command, "allow_overwrite is mandatory"

def persist(self, command: dict, key: str):

self._validate_persist_parameters(command)

try:

retrieve_func = command["retrieve_func"]

if retrieve_func == OfflineServer.get_historical_features.__name__:

ret_job = self.get_historical_features(command, key)

elif (

retrieve_func == OfflineServer.pull_latest_from_table_or_query.__name__

ret_job = self.pull_latest_from_table_or_query(command)

elif retrieve_func == OfflineServer.pull_all_from_table_or_query.__name__:

ret_job = self.pull_all_from_table_or_query(command)

else:

raise NotImplementedError

data_source = self.store.get_data_source(command["data_source_name"])

assert_permissions(

resource=data_source,

actions=[AuthzedAction.WRITE_OFFLINE],

)

storage = SavedDatasetStorage.from_data_source(data_source)

ret_job.persist(storage, command["allow_overwrite"], command["timeout"])

except Exception as e:

logger.exception(e)

traceback.print_exc()

raise e

@staticmethod

def _extract_data_source_from_command(command) -> DataSource:

data_source_proto_str = command["data_source_proto"]

logger.debug(f"Extracted data_source_proto {data_source_proto_str}")

data_source_proto = DataSourceProto()

Parse(data_source_proto_str, data_source_proto)

data_source = DataSource.from_proto(data_source_proto)

logger.debug(f"Converted to DataSource {data_source}")

return data_source

def validate_data_source(self, command: dict):

data_source = OfflineServer._extract_data_source_from_command(command)

logger.debug(f"Validating data source {data_source.name}")

assert_permissions(data_source, actions=[AuthzedAction.READ_OFFLINE])

self.offline_store.validate_data_source(

config=self.store.config,

data_source=data_source,

)

def get_table_column_names_and_types_from_data_source(self, command: dict):

data_source = OfflineServer._extract_data_source_from_command(command)

logger.debug(f"Fetching table columns metadata from {data_source.name}")

assert_permissions(data_source, actions=[AuthzedAction.READ_OFFLINE])

column_names_and_types = data_source.get_table_column_names_and_types(

self.store.config

)

column_names, types = zip(*column_names_and_types)

logger.debug(

f"DataSource {data_source.name} has columns {column_names} with types {types}"

)

return pa.table({"name": column_names, "type": types})

def serve(self):

message = "offline server starting with pid: "

logger.info(

message + "[%d]",

os.getpid(),

extra={"color_message": message + "[" + click.style("%d", fg="cyan") + "]"},

)

super().serve()

def shutdown(self):

message = "Sending a shutdown signal to the offline server running with pid:: "

logger.info(

message + "[%d]",

os.getpid(),

extra={"color_message": message + "[" + click.style("%d", fg="cyan") + "]"},

)

super().shutdown()

def remove_dummies(fv: FeatureView) -> FeatureView:

"""

Removes dummmy IDs from FeatureView instances created with FeatureView.from_proto

"""

if DUMMY_ENTITY_NAME in fv.entities:

fv.entities = []

fv.entity_columns = []

return fv

def _init_auth_manager(store: FeatureStore):

auth_type = str_to_auth_manager_type(store.config.auth_config.type)

init_security_manager(auth_type=auth_type, fs=store)

init_auth_manager(

auth_type=auth_type,

server_type=ServerType.ARROW,

auth_config=store.config.auth_config,

)

def start_server(

store: FeatureStore,

host: str,

port: int,

tls_key_path: str = "",

tls_cert_path: str = "",

_init_auth_manager(store)

tls_certificates = []

scheme = "grpc+tcp"

if tls_key_path and tls_cert_path:

logger.info(

"Found SSL certificates in the args so going to start offline server in TLS(SSL) mode."

)

scheme = "grpc+tls"

with open(tls_cert_path, "rb") as cert_file:

tls_cert_chain = cert_file.read()

with open(tls_key_path, "rb") as key_file:

tls_private_key = key_file.read()

tls_certificates.append((tls_cert_chain, tls_private_key))

location = "{}://{}:{}".format(scheme, host, port)

server = OfflineServer(

store,

location=location,

host=host,

tls_certificates=tls_certificates,

)

try:

logger.info(f"Offline store server serving at: {location}")

server.serve()

except KeyboardInterrupt:

logger.info("KeyboardInterrupt received, stopping the offline server.")

finally:

server.shutdown()

logger.info("offline server stopped.")

sys.exit(0)

feast/sdk/python/feast/offline_server.py at apply-progress · feast-dev/feast · GitHub

Uh oh!

Expand file tree

Breadcrumbs

offline_server.py

Latest commit

History

Breadcrumbs

offline_server.py

File metadata and controls