Version History (#768)

* Stash. Super rough progress * Stash * 'h' how toggles history panel Add documents.restore endpoint * Add tests for documents.restore endpoint * Document restore endpoint * Tiding, RevisionMenu, remove scroll dep * Add history menu item * Paginate loading * Fixed: Error boundary styling Select first revision faster * Diff summary, styling * Add history loading placeholder Fix move modal not opening * Fixes: Refreshing page on specific revision * documentation for document.revision * Better handle versions with no text changes (will no longer be created)
2018-09-29 21:24:07 -07:00
parent 7973bfeca2
commit d0bee23432
28 changed files with 794 additions and 85 deletions
--- a/app/components/DocumentHistory/DocumentHistory.js
+++ b/app/components/DocumentHistory/DocumentHistory.js
@@ -0,0 +1,138 @@
+// @flow
+import * as React from 'react';
+import { withRouter } from 'react-router-dom';
+import { observable, action } from 'mobx';
+import { observer, inject } from 'mobx-react';
+import styled from 'styled-components';
+import Waypoint from 'react-waypoint';
+import ArrowKeyNavigation from 'boundless-arrow-key-navigation';
+
+import { DEFAULT_PAGINATION_LIMIT } from 'stores/DocumentsStore';
+import Document from 'models/Document';
+import RevisionsStore from 'stores/RevisionsStore';
+
+import Flex from 'shared/components/Flex';
+import { ListPlaceholder } from 'components/LoadingPlaceholder';
+import Revision from './components/Revision';
+import { documentHistoryUrl } from 'utils/routeHelpers';
+
+type Props = {
+  match: Object,
+  document: Document,
+  revisions: RevisionsStore,
+  revision?: Object,
+  history: Object,
+};
+
+@observer
+class DocumentHistory extends React.Component<Props> {
+  @observable isLoaded: boolean = false;
+  @observable isFetching: boolean = false;
+  @observable offset: number = 0;
+  @observable allowLoadMore: boolean = true;
+
+  async componentDidMount() {
+    this.selectFirstRevision();
+    await this.loadMoreResults();
+    this.selectFirstRevision();
+  }
+
+  fetchResults = async () => {
+    this.isFetching = true;
+
+    const limit = DEFAULT_PAGINATION_LIMIT;
+    const results = await this.props.revisions.fetchPage({
+      limit,
+      offset: this.offset,
+      id: this.props.document.id,
+    });
+
+    if (
+      results &&
+      (results.length === 0 || results.length < DEFAULT_PAGINATION_LIMIT)
+    ) {
+      this.allowLoadMore = false;
+    } else {
+      this.offset += DEFAULT_PAGINATION_LIMIT;
+    }
+
+    this.isLoaded = true;
+    this.isFetching = false;
+  };
+
+  selectFirstRevision = () => {
+    const revisions = this.revisions;
+    if (revisions.length && !this.props.revision) {
+      this.props.history.replace(
+        documentHistoryUrl(this.props.document, this.revisions[0].id)
+      );
+    }
+  };
+
+  @action
+  loadMoreResults = async () => {
+    // Don't paginate if there aren't more results or we’re in the middle of fetching
+    if (!this.allowLoadMore || this.isFetching) return;
+    await this.fetchResults();
+  };
+
+  get revisions() {
+    return this.props.revisions.getDocumentRevisions(this.props.document.id);
+  }
+
+  render() {
+    const showLoading = !this.isLoaded && this.isFetching;
+    const maxChanges = this.revisions.reduce((acc, change) => {
+      if (acc < change.diff.added + change.diff.removed) {
+        return change.diff.added + change.diff.removed;
+      }
+      return acc;
+    }, 0);
+
+    return (
+      <Wrapper column>
+        {showLoading ? (
+          <Loading>
+            <ListPlaceholder count={5} />
+          </Loading>
+        ) : (
+          <ArrowKeyNavigation
+            mode={ArrowKeyNavigation.mode.VERTICAL}
+            defaultActiveChildIndex={0}
+          >
+            {this.revisions.map((revision, index) => (
+              <Revision
+                key={revision.id}
+                revision={revision}
+                document={this.props.document}
+                maxChanges={maxChanges}
+                showMenu={index !== 0}
+              />
+            ))}
+          </ArrowKeyNavigation>
+        )}
+        {this.allowLoadMore && (
+          <Waypoint key={this.offset} onEnter={this.loadMoreResults} />
+        )}
+      </Wrapper>
+    );
+  }
+}
+
+const Loading = styled.div`
+  margin: 0 16px;
+`;
+
+const Wrapper = styled(Flex)`
+  position: fixed;
+  top: 0;
+  right: 0;
+  bottom: 0;
+
+  min-width: ${props => props.theme.sidebarWidth};
+  border-left: 1px solid ${props => props.theme.slateLight};
+  overflow: scroll;
+  overscroll-behavior: none;
+`;
+
+export default withRouter(inject('revisions')(DocumentHistory));