iodide-project/iodide

validate _all_ API args, break out API arg validation in #1703 into a little library that we can use to

Open

#1 760 ouverte le 22 avr. 2019

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)JavaScript (1 483 stars) (147 forks)batch import
good first issue

Description

following from @hamilton's nice file API argument validation in #1703, we should apply argument validation to all of the iodide API. in the process, we should break the argument validation into proptypes-style helper function

see: https://github.com/iodide-project/iodide/pull/1703#discussion_r274200088

export function loadFile(fileName, fetchType, variableName = undefined) {
  argType.validate({
    fileName: [fileName, argType.string],
    fetchType: [fetchType, argType.enum(FETCH_RETURN_TYPES)],
    variableName: [variableName, argType.string.optional]
  })
  return sendFileRequestToEditor(fileName, "LOAD_FILE", {
    fetchType
  }).request.then(handleResourceLoad(fetchType, variableName));
}

Guide contributeur

Stack technique
javascript
Domaine
backenddeveloper experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
understanding of argType validation from PR #1703familiarity with iodide API
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
First, review the argType validation implementation in PR #1703 (linked in the issue). Then, identify all API functions in the iodide codebase that accept arguments, and apply similar validation to each. Consider extracting the validation logic into a shared helper library as suggested.