ZEPPELIN-143: Git as a versioned notebook storage #497
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.apache.zeppelin.notebook.repo; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.List; | ||
|
|
||
| import org.apache.zeppelin.conf.ZeppelinConfiguration; | ||
| import org.apache.zeppelin.notebook.Note; | ||
| import org.eclipse.jgit.api.Git; | ||
| import org.eclipse.jgit.api.errors.GitAPIException; | ||
| import org.eclipse.jgit.diff.DiffEntry; | ||
| import org.eclipse.jgit.dircache.DirCache; | ||
| import org.eclipse.jgit.internal.storage.file.FileRepository; | ||
| import org.eclipse.jgit.lib.Repository; | ||
| import org.eclipse.jgit.revwalk.RevCommit; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import com.google.common.base.Joiner; | ||
| import com.google.common.collect.Lists; | ||
|
|
||
| /** | ||
| * NotebookRepo that hosts all the notebook FS in a single Git repo | ||
| * | ||
| * This impl intended to be simple and straightforward: | ||
| * - does not handle branches | ||
| * - only basic local git file repo, no remote Github push\pull yet | ||
| * | ||
| * TODO(bzz): add default .gitignore | ||
| */ | ||
| public class GitNotebookRepo extends VFSNotebookRepo implements NotebookRepoVersioned { | ||
| private static final Logger LOG = LoggerFactory.getLogger(GitNotebookRepo.class); | ||
|
|
||
| private String localPath; | ||
| private Git git; | ||
|
|
||
| public GitNotebookRepo(ZeppelinConfiguration conf) throws IOException { | ||
| super(conf); | ||
| localPath = getRootDir().getName().getPath(); | ||
| LOG.info("Opening a git repo at '{}'", localPath); | ||
| Repository localRepo = new FileRepository(Joiner.on(File.separator).join(localPath, ".git")); | ||
| if (!localRepo.getDirectory().exists()) { | ||
| LOG.info("Git repo {} does not exist, creating a new one", localRepo.getDirectory()); | ||
| localRepo.create(); | ||
| } | ||
| git = new Git(localRepo); | ||
|
Member
There was a problem hiding this comment. does the localRepo need to be
Member
Author
There was a problem hiding this comment. Very good point, thank you! addressed in 5d7ffea |
||
| maybeAddAndCommit("."); | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized void save(Note note) throws IOException { | ||
| super.save(note); | ||
| maybeAddAndCommit(note.getId()); | ||
| } | ||
|
|
||
| private void maybeAddAndCommit(String pattern) { | ||
| try { | ||
| List<DiffEntry> gitDiff = git.diff().call(); | ||
| if (!gitDiff.isEmpty()) { | ||
| LOG.debug("Changes found for pattern '{}': {}", pattern, gitDiff); | ||
| DirCache added = git.add().addFilepattern(pattern).call(); | ||
| LOG.debug("{} changes are about to be commited", added.getEntryCount()); | ||
| git.commit().setMessage("Updated " + pattern).call(); | ||
| } else { | ||
| LOG.debug("No changes found {}", pattern); | ||
| } | ||
| } catch (GitAPIException e) { | ||
| LOG.error("Faild to add+comit {} to Git", pattern, e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Note get(String noteId, String rev) throws IOException { | ||
| //TODO(bzz): something like 'git checkout rev', that will not change-the-world though | ||
| return super.get(noteId); | ||
| } | ||
|
|
||
| @Override | ||
| public List<Rev> history(String noteId) { | ||
| List<Rev> history = Lists.newArrayList(); | ||
| LOG.debug("Listing history for {}:", noteId); | ||
| try { | ||
| Iterable<RevCommit> logs = git.log().addPath(noteId).call(); | ||
| for (RevCommit log: logs) { | ||
| history.add(new Rev(log.getName(), log.getCommitTime())); | ||
| LOG.debug(" - ({},{})", log.getName(), log.getCommitTime()); | ||
| } | ||
| } catch (GitAPIException e) { | ||
| LOG.error("Failed to get logs for {}", noteId, e); | ||
| } | ||
| return history; | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| git.getRepository().close(); | ||
| } | ||
|
|
||
| //DI replacements for Tests | ||
| Git getGit() { | ||
| return git; | ||
| } | ||
|
|
||
| void setGit(Git git) { | ||
| this.git = git; | ||
| } | ||
|
|
||
|
|
||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
would we be handling push in the future? if so, how would it fit into the API or would there be new API for checkpointing/pushing to remote?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Checkpointing happens in Git on commit level, so I was thinking that push, if have enough user demand, can be implemented on the NotebookRepoSync level, like a FS->S3 sync does.
This should not require big API changes here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1 for remote push :)