Define an API to query records history #875
Conversation
GitHub displays the committer date so if we only use `--date` option to git commit, the date displayed on GitHub UI when browsing history is confusing
No more git checkout drastically improves performance and ensures that the repository is not checked out to a commit in the middle of the history in case of an error. Also allow to order commit before iteration. Also unify and improve returned commits data Lazy load record content
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
Co-authored-by: Matti Schneider <matti@opentermsarchive.org>
| @@ -106,3 +106,10 @@ overrides: | |||
| rules: | |||
| func-names: 0 | |||
| import/no-extraneous-dependencies: 0 | |||
| - files: | |||
| - src/**/*[iI]nterface.js | |||
There was a problem hiding this comment.
Why do you need both I and i ?
I see only one interface.js file in lower case
There was a problem hiding this comment.
At the beginning my file was named repositoryInterface.js and I renamed it after.
The rules I defined will be true for all interfaces so I support all naming.
| @@ -0,0 +1,61 @@ | |||
| import path from 'path'; | |||
There was a problem hiding this comment.
I'm unsure about when this script should be used and if it can be an safely on any repository.
A comment at the top of this file would be enough if it states
- purpose
- sample usage
- ran twice will not produce error
| @@ -0,0 +1,23 @@ | |||
| import fsApi from 'fs'; | |||
There was a problem hiding this comment.
This seems to be only working for git so 2 options
- move it to git folder
- name it
importReadmeInGit
src/archivist/index.js
Outdated
| @@ -41,9 +41,9 @@ export default class Archivist extends events.EventEmitter { | |||
| return Object.keys(this.services); | |||
| } | |||
|
|
|||
| constructor({ storage: { versions, snapshots } }) { | |||
| constructor(config) { | |||
There was a problem hiding this comment.
Passing the whole config, while being convenient, makes it very difficult to know what is used.
I suggest only passing recorder config like
constructor({ recorder }) {
and call it with
app = new Archivist({ recorder: config.get("recorder")});
| @@ -0,0 +1,212 @@ | |||
| import fsApi from 'fs'; | |||
There was a problem hiding this comment.
This implementation seems very clear to me but have the downside that every migration created will have commitable changes.
I think this may not be part of this PR but it would be great to have the config loaded from a gitignored file .migration.json
Only change needed would be to add the type of repository to it so that the right repository class is used
There was a problem hiding this comment.
Ok, I'm going to do this in another PR to allow merging this one.
GitRepositoryandMongoRespositorystorage-adapterstorepositoriesto properly the Repository adn Data Mapper patterns