zeroshade commented on code in PR #1213: URL: https://github.com/apache/iceberg-go/pull/1213#discussion_r3461456481
########## table/scan_planning.go: ########## @@ -0,0 +1,138 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +// This file is a PROPOSED public API surface for REST server-side scan +// planning (apache/iceberg-go#1178). It defines the table-side seam — the +// option, request/result types, and the ScanPlanner interface (implemented by +// catalog/rest) — so it can be reviewed as Go rather than prose. +// WithScanPlanningMode records the requested mode on the Scan, but nothing reads +// it until scanner delegation lands, so nothing here changes existing behavior. + +package table + +import ( + "context" + + "github.com/apache/iceberg-go" + icebergio "github.com/apache/iceberg-go/io" +) + +// ScanPlanningMode is the user-facing scan option: three values +// (local/remote/auto) selecting how (*Scan).PlanFiles plans a scan. Local +// planning remains the default; remote is opt-in via WithScanPlanningMode. +// +// This is deliberately distinct from the REST table-config key +// `scan-planning-mode` (values `client`/`server`), which is a server directive +// resolved separately (OQ4): a `client` table forces local planning, a `server` +// table forces remote planning, and explicit conflicting scan options fail +// fast. There is intentionally no fourth `server` value here; the directive +// lives in the table config, not the user option. +type ScanPlanningMode string + +const ( + // ScanPlanningLocal always plans locally by reading manifests through the + // table's FileIO. This is the default and current behavior. + ScanPlanningLocal ScanPlanningMode = "local" + // ScanPlanningRemote requires a planner that advertises remote capability + // and fails loudly if remote planning is unavailable. + ScanPlanningRemote ScanPlanningMode = "remote" + // ScanPlanningAuto uses remote planning when available and allowed by the + // table config, otherwise falls back to local. + ScanPlanningAuto ScanPlanningMode = "auto" +) + +// WithScanPlanningMode sets the scan-planning mode for a scan. The default is +// ScanPlanningLocal unless the REST table config requires server planning. +func WithScanPlanningMode(mode ScanPlanningMode) ScanOption { + return func(scan *Scan) { scan.planningMode = mode } Review Comment: Non-blocking, but worth settling here: `WithScanPlanningMode` is live and exported, yet `planningMode` is read by nothing until the delegation phase — so `WithScanPlanningMode(ScanPlanningRemote)` silently produces a *local* plan today, which contradicts the doc just above ("fails loudly if remote planning is unavailable"). If a release is cut between this PR and the delegation phase, the option ships as a silent no-op. Cheap guard: have `(*Scan).PlanFiles` return an error for remote/auto-without-capable-planner now, or hold the exported option until delegation lands. ########## catalog/rest/scan_planning.go: ########## @@ -0,0 +1,254 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +// This file is a PROPOSED public API surface for REST server-side scan +// planning (apache/iceberg-go#1178). The method bodies are intentionally +// unimplemented stubs (returning ErrNotImplemented) so the REST surface can be +// reviewed as Go — with one exception: PlanTableScanResponse.UnmarshalJSON +// validates the status/plan-id union (with tests), added per review. +// Endpoint capability discovery (Endpoint, SupportsEndpoint) lands separately +// in the Phase 0 PR and is intentionally not redeclared here. + +package rest + +import ( + "context" + "encoding/json" + "fmt" + "time" + + "github.com/apache/iceberg-go" + "github.com/apache/iceberg-go/table" +) + +// Compile-time proof that the REST catalog satisfies the table planner seam. +var _ table.ScanPlanner = (*Catalog)(nil) + +// ErrPlanExpired is returned when polling a plan-id the server no longer knows +// about (HTTP 404 while polling), distinct from a table-not-found 404. +var ErrPlanExpired = fmt.Errorf("%w: scan plan expired", ErrRESTError) + +// --- Capability gating (Open Question 2) ------------------------------------ +// +// A single capability check is too coarse: requiring all four endpoints falls +// back to local against sync-only servers, while requiring only the plan +// endpoint false-positives, because planTableScan can return `submitted` or +// `plan-tasks` that need the poll/fetch endpoints. The split below lets `auto` +// use a sync-only server while reserving the async/fanout path for servers +// that advertise everything. + +// SupportsPlanTableScan reports whether the server advertised the synchronous +// plan endpoint. +func (r *Catalog) SupportsPlanTableScan() bool { + return false +} + +// SupportsFullRemoteScanPlanning reports whether the server advertised all four +// scan-planning endpoints (plan, fetch-result, cancel, fetch-tasks). +func (r *Catalog) SupportsFullRemoteScanPlanning() bool { + return false +} + +// --- table.ScanPlanner implementation --------------------------------------- + +// SupportsRemoteScanPlanning reports whether this catalog can complete a remote +// plan end-to-end; backed by the split capability checks above. +func (r *Catalog) SupportsRemoteScanPlanning() bool { + return false +} + +// PlanFiles plans a scan server-side and returns tasks (and, optionally, a +// plan-scoped FileIO) for the table to read. +func (r *Catalog) PlanFiles(ctx context.Context, req table.ScanPlanningRequest) (table.ScanPlanningResult, error) { + return table.ScanPlanningResult{}, fmt.Errorf("%w: REST scan planning", iceberg.ErrNotImplemented) +} + +// --- Low-level client methods ----------------------------------------------- + +// PlanTableScan submits a scan plan. The result is either completed inline, +// submitted (returns a plan-id to poll), or failed. +func (r *Catalog) PlanTableScan(ctx context.Context, ident table.Identifier, req PlanTableScanRequest) (PlanTableScanResponse, error) { + return PlanTableScanResponse{}, fmt.Errorf("%w: plan table scan", iceberg.ErrNotImplemented) +} + +// FetchPlanningResult polls a previously submitted plan. +func (r *Catalog) FetchPlanningResult(ctx context.Context, ident table.Identifier, planID string) (FetchPlanningResultResponse, error) { + return FetchPlanningResultResponse{}, fmt.Errorf("%w: fetch planning result", iceberg.ErrNotImplemented) +} + +// CancelPlanning cancels a server-side plan. Callers should cancel on context +// cancellation using a detached context with a short timeout. +func (r *Catalog) CancelPlanning(ctx context.Context, ident table.Identifier, planID string) error { + return fmt.Errorf("%w: cancel planning", iceberg.ErrNotImplemented) +} + +// FetchScanTasks fetches the scan tasks for a plan-task handle returned by a +// completed plan. +func (r *Catalog) FetchScanTasks(ctx context.Context, ident table.Identifier, req FetchScanTasksRequest) (FetchScanTasksResponse, error) { + return FetchScanTasksResponse{}, fmt.Errorf("%w: fetch scan tasks", iceberg.ErrNotImplemented) +} + +// WaitForPlan polls a submitted plan to completion using jittered backoff, +// cancelling the server-side plan if the context is cancelled. The total wait is +// bounded by the context deadline; it returns an error if the deadline passes +// while still submitted, or if the plan is cancelled, failed, or expired. +func (r *Catalog) WaitForPlan(ctx context.Context, ident table.Identifier, planID string, opts WaitForPlanOptions) (CompletedPlanningResult, error) { + return CompletedPlanningResult{}, fmt.Errorf("%w: wait for plan", iceberg.ErrNotImplemented) +} + +// --- Wire types (sketch) ---------------------------------------------------- +// +// Content-file, delete-file, and residual decoding lands with the scan-task +// decoder PR; these sketch the request/response envelopes so the client +// surface compiles and reads. + +// PlanStatus is the status of a server-side plan. +type PlanStatus string + +const ( + PlanStatusCompleted PlanStatus = "completed" + PlanStatusSubmitted PlanStatus = "submitted" + // PlanStatusCancelled is valid when polling a submitted plan, but invalid + // as a planTableScan response. PlanTableScan and WaitForPlan should treat a + // cancelled initial planning response as an error. + PlanStatusCancelled PlanStatus = "cancelled" + PlanStatusFailed PlanStatus = "failed" +) + +// PlanningError is the ErrorModel payload carried by a failed planning result. +type PlanningError = errorResponse Review Comment: Minor surface nit: `PlanningError = errorResponse` exports an alias to an unexported struct, so godoc renders an unexported underlying type and the embedded `wrapping error` field stays inaccessible to external callers. Works fine for the wire payload; just flagging it as a slightly unusual public shape to confirm intentional. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
