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

initial TODOs #1

Closed
jmartin-sul opened this issue Jul 26, 2019 · 1 comment
Closed

initial TODOs #1

jmartin-sul opened this issue Jul 26, 2019 · 1 comment
Labels

Comments

@jmartin-sul
Copy link
Collaborator

jmartin-sul commented Jul 26, 2019

these should probably spawn separate individual follow-on tickets with more low-level detail, but here is a short high-level list of the initial things that need to be done to make this codebase production-worthy:

  • see write README #13 README
  • see allow specification of serialization type for exported RDF #14 specification of serialization type for the RDF that's downloaded. presently, the retrieval function has a param that defaults to ld+json, but there's no facility to override that in the calling functions, and there's nothing like class level configuration (because it's just loose functions at the moment).
  • see write devopsdocs #12 DevOpsDocs
  • see add error handling #11 error handling. because there isn't any currently.
  • see hook up to circleci #7 hook up to circle for continuous integration
  • see write tests #6 write tests. jest is already included as a dependency. my gut feeling at this point is that we should be able to mock the network connection part for simulating resource retrieval success/error, and do the rest as unit tests without mocking anything.
  • see license #5 license
  • see make sinopia_exporter usable as a command line script #4 make this usable from the command-line in a single invocation. for the initial code that i splatted out yesterday, i was just building and testing things from the node console. my inclination was to do something like the sinopia_acl codebase, using commander.js to parse options as needed. i have vague recollections of @mjgiarlo saying that commander didn't play so nicely with asynchronous functions and promises in general. but similar to what that codebase does for obtaining a cognito token, i think it's fine for commander to just kick off some asynchronous work, and to let the user check for the output files to see whether things are done. as it is, the test code will write a log file upon successful retrieval of all resources from a group. not sure if we want fancier or more user friendly indicators of completion.
  • see make sinopia_exporter usable as a command line script #4, for which this bit of work was a prereq structure https://github.com/LD4P/sinopia_exporter/blob/master/src/getGroupRDF.js so that it has proper exports and whatnot. this is my first time spinning up a node project from scratch, so when i wasn't able to get that working, i concentrated on getting the underlying retrieval mechanisms working. i figured i could do some pairing to get past that structural stuff with someone more node-savvy than i.

see also LD4P/sinopia_editor#797

@jmartin-sul
Copy link
Collaborator Author

broke the TODO list in the description out into individual issues, closing this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant