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

📝 DOP-4098 updates comment #931

Merged
merged 5 commits into from
Nov 3, 2023
Merged

📝 DOP-4098 updates comment #931

merged 5 commits into from
Nov 3, 2023

Conversation

caesarbell
Copy link
Collaborator

@caesarbell caesarbell commented Nov 2, 2023

Part of me searching through all DOP codebases to ensure we are not pulling in prefix, bucket, and URL from repo_branches, I stumbled across an outdated comment, and this PR updates that to reflect that we are now caching from docsets

This PR has been updated for updating the Types as well to reflect the changes betweenrepos_branches and docsets

Copy link

github-actions bot commented Nov 2, 2023

The URL for your feature branch webhook is https://bx7y7vb6xf.execute-api.us-east-2.amazonaws.com/prod/

Copy link
Contributor

@mmeigs mmeigs left a comment

Choose a reason for hiding this comment

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

❤️

Copy link
Contributor

@seungpark seungpark left a comment

Choose a reason for hiding this comment

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

LGTM !

Copy link
Contributor

@mmeigs mmeigs left a comment

Choose a reason for hiding this comment

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

Seems good to me! Thank you for the clean-up!

internalOnly: boolean;
[key: string]: any;
}

const internals: { [key: project]: ReposBranchesDocument } = {};
export type ReposBranchesDocsetsDocument = ReposBranchesDocument & DocsetsDocument;
Copy link
Contributor

Choose a reason for hiding this comment

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

what is this new document type?

IIUC it contains url, prefix, bucket but also repoName, project, ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That is correct. The new document type is a combination of repos_branches and docsets. The following properties come from docsets now, which are prefix, bucket and URL.

Copy link
Contributor

@seungpark seungpark Nov 3, 2023

Choose a reason for hiding this comment

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

are we constructing a document with both of these properties? seeing that neither repos_branches or docsets collections has all of these properties defined. think we should be defining ReposBranchesDocument and DocsetsDocument separately, not combining them into one. (if connecting the two types, it should be that docsets have a repos property that is ReposBranchesDocument[] as in the data:

image

image

Copy link
Contributor

Choose a reason for hiding this comment

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

We're aggregating the two together to have a flat access to all of the properties!

@caesarbell caesarbell merged commit 417c7fb into master Nov 3, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants