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

Draft SDK type changes for incremental sync #2914

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

patrick-codaio
Copy link
Contributor

No description provided.

@@ -88,6 +88,9 @@ function hasComment(data: ReflectionData): boolean {
}

function messageForEntity(data: ReflectionData): string {
if (!data.kindString) {
throw new Error(`No kindString for ${data.name}, did you forget to add /** ... */ comments?`);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drive by improvement:

Before:
Screenshot 2024-02-29 at 9 55 55 AM
After:
Screenshot 2024-02-29 at 9 55 47 AM

api.ts Outdated Show resolved Hide resolved
api.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@dweitzman-codaio dweitzman-codaio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The type stuff makes sense to me. Had some questions about versioning and naming

api.ts Outdated Show resolved Hide resolved

// TODO(patrick): Unhide this
/** @hidden */
prevSyncContinuation?: Continuation;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The name prevSyncContinuation doesn't feel that distinct from continuation

I wonder if it's worth doing a quick naming brainstorm & voting exercise in a doc? Personally I might lean toward a name more like incrementalSyncBase to clearly distinguish it from non-incremental sync.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right, I'll make a doc.

api.ts Outdated
* TODO(patrick): Unhide this
* @hidden
*/
syncExecutionCompletionMetadata?: SyncExecutionCompletionMetadata;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: The key name seems overly verbose. Would metadata suffice? Or perhaps completion?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like how completion matches continuation, I'll use that.

Copy link

This pull request has been inactive for 7 days: labeled as stale. To avoid auto-closure in 7 days, please do one of the following: Add keep-active label, comment on PR, push new commit on PR.

@github-actions github-actions bot added the stale label Mar 14, 2024
@patrick-codaio patrick-codaio added keep-active Prevent auto-closing as stale and removed stale labels Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
keep-active Prevent auto-closing as stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants