ComponentBuild from ScratchUse APIMain Risk ReducedDrag-and-drop upload UI2–3 savaites< 1 val.Lankytojo naršyklės problemos, prieinamumo problemosDidelės ir daug failų įkėlimo1–2 savaitesPaprastas diegimasTinklo gedimai, didelių failų tvarkymasVirusų nuskaitymas ir saugumasIšskirtinė priežiūraĮtrauktaŽalinga programinė įranga, saugumo pažeidžiamumaiFailo apdorojimas (PDF konvertavimas, vaizdo optimizavimas)1+ savaitėra pagal formatąPaprastas bibliotekos priežiūra, formato palaikymasCDN pristatymas1–2 savaitesĮtrauktasLėtas įkėlimas, skalavimo problemos Kai komandai paprašoma „greitai sukurti pateikimo portalą“, iš pradžių tai skamba lengvai.Galbūt manote, kad tai užtruks tik porą sprintų. Tvarkyti failų įkėlimą realiame gyvenime nėra paprasta. Turite susidoroti su dideliais failais, pvz., 300 MB ZIP, sugedusiais PDF, saugumo patikrinimais, skirtingomis naršyklėmis ir studentais, pateiktais prieš pat terminą. Pagrindinės funkcijos, pvz., Naudotojo vaidmenys, paskyrimai ir klasifikavimas, iš tikrųjų yra gana paprastos. Šis vadovas skirtas inžinerijos lyderiams, kurie nori išvengti šios situacijos. Vietoj to, kad sukurtumėte failų tvarkymą nuo nulio, galite naudoti paruoštas failų paslaugas per API. Key Takeaways Pagrindiniai Takeaways Failų tvarkymas yra sudėtingiausia pateikimo portalo dalis, o ne pagrindinės CRUD funkcijos. Laikykite savo pagrindinę programos logiką atskirai nuo failų tvarkymo, kad sukurtumėte greičiau. Naudokite API įkėlimui, apdorojimui ir saugumui, o ne viską kurti patys. Automatizuokite virusų nuskaitymą, failų patikrinimus ir konversijas naudojant darbo eigą ir tinklalapius. Skirkite savo inžinerinį laiką funkcijoms, kurios daro jūsų produktą unikaliu, o ne failų sistemų valdymui. Why “Just Build It” Costs More Than You Think Kodėl „Just Build It“ kainuoja daugiau, nei manote Prieš kalbėdami apie architektūrą, būkime sąžiningi apie realią aprėptį. Geras pateikimo portalas turi dvi pagrindines dalis, ir jos nėra vienodai sunkios. Vartotojai, vaidmenys, paskyrimai ir reitingai. Part one: Tai nuspėjamas darbas. Jūsų komanda anksčiau sukūrė CRUD programas. Duomenų bazės struktūra yra aiški, krašto atvejus galima valdyti, ir galite įvertinti pastangas. failų tvarkymas. Part two: Štai kur pasirodo paslėptos pastangos. Gamybos paruošta failų sistema reikalauja daug daugiau nei paprastas įkėlimo mygtukas. Slinkite ir nuleiskite įkėlimą, kuris veikia visose naršyklėse ir įrenginiuose. Pagalba dideliems failams, naudojant susmulkintus įkėlimus (todėl įkėlimai nepavyksta, jei tinklas nukrenta). Virusų nuskaitymas prieš saugant failus. Automatinis failų formato patikrinimas (nes kažkas įkelia neteisingą formatą). Konvertuoti dokumentus į PDF nuosekliam klasifikavimui. Saugios, ribotos trukmės prieigos nuorodos. CDN pristatymas greitam prieigai. Įrenginys, kuris automatiškai keičiasi. Kiekvienas iš jų yra projektas savaime. Štai kaip pritaikytas pastatas lyginamas su API naudojimu: ComponentBuild from ScratchUse APIMain Risk ReducedDrag-and-drop upload UI2–3 savaites< 1 val.Lankytojo naršyklės problemos, prieinamumo problemosDidelės ir daug failų įkėlimo1–2 savaitesPaprastas diegimasTinklo gedimai, didelių failų tvarkymasVirusų nuskaitymas ir saugumasIšskirtinė priežiūraĮtrauktaŽalinga programinė įranga, saugumo pažeidžiamumaiFailo apdorojimas (PDF konvertavimas, vaizdo optimizavimas)1+ savaitėra pagal formatąPaprastas bibliotekos priežiūra, formato palaikymasCDN pristatymas1–2 savaitesĮtrauktasLėtas įkėlimas, skalavimo problemos komponentas Sukurtas iš scratch Naudokite ugnį Mažėja pagrindinė rizika Taigi šis pasirinkimas iš tikrųjų nėra apie tai, ar jūsų komanda Ką daryti?Kalbama apie tai, ar jie Praleiskite laiką statydami. Gali Turėtų Geriau praleisti kuriant funkcijas, kurios leidžia jūsų portalui išsiskirti ir būti naudinga, o ne atkurti failų sistemas ir įrankius, kurie jau yra prieinami ir patikimi. Taigi, jei failų tvarkymas yra ten, kur gyvena dauguma paslėptų sudėtingumo, tikrasis klausimas tampa: kaip mes turėtume suprojektuoti sistemą kitaip? The Architecture That Enables Speed Architektūra, leidžianti greitį Greitai gabenančios komandos laikosi vienos paprastos idėjos: aiškiai atskirti pagrindinę programos logiką nuo failų tvarkymo. Štai kaip tai atrodo praktikoje: Pagalvokite apie tris paprastus sluoksnius: Frontend: sąsaja, kurioje studentai pateikia darbą, o absolventai jį peržiūri. Verslo logika: terminų, pateikimo, reitingavimo ir leidimų taisyklės. Duomenų modelis: duomenų bazės struktūra: naudotojai, paskyrimai, pateikimai ir įvertinimai. Jūsų komanda orientuota tik į šiuos tris sluoksnius. Nuo to momento, kai studentas paspaudžia kol gradientas atidaro failą, viskas, kas susijusi su pačiu failu, įkėlimu, saugojimu, nuskaitymo saugumui ir apdorojimui, yra tvarkoma failų tarnyba, pvz., Filestack. “Submit” Laikydami failų tvarkymą atskirai, jūsų sistema išlieka švaresnė, greičiau kuriama ir daug lengviau prižiūrima. Kai atskiriate verslo logiką nuo failų tvarkymo, įgyvendinimas tampa daug paprastesnis. Implementation: The Three Accelerators Žymos archyvas: trys akceleratoriai Šiuo metu tikslas yra paprastas: paversti darbo savaites vos keliomis dienomis, sutelkiant dėmesį tik į tas dalis, kurios daro jūsų portalą unikalią. Šie trys greitintuvai pašalina didžiausius sulėtėjimus: failų įkėlimą, failų apdorojimą ir failų pristatymą, todėl jūsų komanda gali kurti greičiau, nekenkiant kokybei ar saugumui. 1. The Upload Experience Pateikimo forma yra svarbiausia vartotojo požiūriu jūsų portalo dalis.Tai taip pat yra vieta, kur priekinės dalies sudėtingumas sparčiai auga, jei viską sukursite patys. Palaikant „Google Drive“, „OneDrive“, „Dropbox“ ir vietinius įkėlimus, išlaikant sklandų slinkimą ir nuleidimą, rodant įkėlimo pažangą ir užtikrinant, kad jis veiktų visose naršyklėse, yra rimta frontend pastangos. Įterpiant „Filestack“ failų rinkiklį, tai sumažėja iki kelių valandų integracijos darbo. Štai kaip jis atrodo React pateikimo formoje: import React, { useState } from "react";
import * as filestack from "filestack-js";

const client = filestack.init("YOUR_API_KEY_HERE");

function FilestackUpload() {
  const [fileData, setFileData] = useState(null);

  const handleUpload = async () => {
    try {
      const result = await client.picker({
        accept: ["image/*"],
        maxFiles: 1,
        maxSize: 5 * 1024 * 1024,
        onUploadDone: (res) => {
          console.log("Upload done:", res);
          setFileData(res.filesUploaded[0]);
        },
      }).open();
    } catch (error) {
      console.error("Upload failed:", error);
    }
  };

  return (
    <div>
      <button onClick={handleUpload}>Upload File</button>

      {fileData && (
        <div style={{ marginTop: "20px" }}>
          <p>File uploaded: {fileData.filename}</p>
          <img src={fileData.url} alt="Uploaded" style={{ maxWidth: "300px" }} />
        </div>
      )}
    </div>
  );
}

export default FilestackUpload;
 Iš dėžutės studentai gauna: Įvairių failų įkėlimas Debesies saugojimo palaikymas Upload pažangos rodikliai Įdiegta klaidų tvarkymas Visa tai palaiko komanda, kuri sutelkia dėmesį į tai, kad failų įkėlimai būtų patikimi. Sukurti didelę Integruodami paruoštą sprendimą, gaunate poliruotą įkėlimo sistemą, nepraleidžiant savaičių, kuriant ir prižiūrint ją patys. „Drag-and-drop“ patirtis Įkėlimas yra tik pirmasis žingsnis. kai failai yra sistemoje, jie turi būti apsaugoti ir apdoroti automatiškai. 2. The Security and Processing Pipeline Kiekvienas studentas įkelia failą yra nežinomas ir gali būti rizikingas. realioje gamybos sistemoje su šimtais ar tūkstančiais vartotojų, virusų nuskaitymas nėra neprivalomas; tai būtina. Be to, nepakanka tik patikrinti failo plėtinį. Failas, vadinamas .pdf, iš tikrųjų gali būti ne tikras PDF. Jums reikia tinkamo failo patvirtinimo. Be saugumo, yra dar viena problema: skirtingi failų formatai. Studentai įkėlė: Vaizdai JPEG, PNG, HEIF, WebP Dokumentai .docx, .pages arba nuskaityti PDF Jei gradientai turi susidoroti su visais šiais skirtingais formatais, jie sulėtėja. Geresnis metodas yra automatiškai apdoroti kiekvieną failą, kai tik jis yra įkeltas. Naudodami „Filestack“ darbo eigos API, galite sukurti automatinį vamzdyną, kuris: Failų nuskaitymas dėl virusų Patikrinkite failų tipus Konvertuoti dokumentus į PDF Kompresuoja didelius vaizdus Optimizuoti failus saugojimui ir pristatymui Visa tai vyksta automatiškai po įkėlimo. Jums nereikia rašyti individualaus kodo kiekvienam failo tipui. Jei norite tai ištirti toliau, Automatizuotos failų apdorojimo darbo eigos organizavimas Išsamiai paaiškina visą diegimą ir apžvelgia, kaip tinkamai konfigūruoti šiuos vamzdynus. Automatizuotos failų apdorojimo darbo eigos organizavimas Jei patys kontroliuojate virusų nuskaitymą, jūs esate atsakingi už: Virusų apibrėžimų atnaujinimas Skenavimo sistemų priežiūra Neteisingi teigiami veiksmai Saugumo pažeidžiamumo stebėjimas Tai tęstinis darbas, kurį jūsų komanda turi tvarkyti amžinai. Naudojant failų API, kuris apima įmontuotą saugumą ir apdorojimą, jūsų komanda vengia ilgalaikės priežiūros ir saugo sistemą daug mažiau pastangų. yra pastatytos tiesiai į API sluoksnį, pašalinant ilgalaikę techninės priežiūros naštą, kurią jūsų komanda kitaip turės valdyti pati. Visapusiškos saugumo priemonės įkėlimams Kai apdorojimas atliekamas automatiškai, galutinis dalykas yra prijungti viską atgal prie jūsų klasifikavimo darbo eigos. 3. Webhooks and the Grading Workflow Štai kur architektūra iš tikrųjų parodo savo vertę. Kai studentas pateikia failą, nenorite sustabdyti visko, kol virusų nuskaitymo ir failų konversijos baigėsi. Vietoj to, jūs priimate pateikimą iš karto, leiskite Filestack apdoroti failą fone ir laukti, kol bus pranešta, kai jis bus paruoštas. Šis pranešimas pateikiamas per a . webhook Jūsų "backend" suteikia specialų galinį tašką, kurį "Filestack" automatiškai paskambina po to, kai failas buvo nuskaitytas, patvirtintas ir apdorotas. # Flask example
@app.route('/webhooks/filestack', methods=['POST'])
def handle_filestack_webhook():
    payload = request.json

    if payload['action'] == 'fp.upload':
        file_handle = payload['data']['url'].split('/')[-1]
        submission_id = payload['metadata']['submission_id']

        # Update submission status in your database
        db.submissions.update(
            {'_id': submission_id},
            {'$set': {
                'status': 'processed',
                'file_handle': file_handle,
                'ready_for_grading': True
            }}
        )

        # Trigger your grading notification
        notify_grader(submission_id)

    return jsonify({'status': 'ok'})
 Štai kas vyksta žingsnis po žingsnio: Studentas įkelia failą. Sistema priima paraišką nedelsiant. Filestack apdoroja failą fone (skenuoti, konvertuoti, optimizuoti). Kai apdorojimas yra baigtas, "Filestack" siunčia "webhook" užklausą jūsų galinei galiai. Jūsų atsarginė dalis atnaujina pateikimo būseną ir praneša gradientui. Dabar failas pažymėtas kaip paruoštas ir gali būti saugiai prieinamas. Šis modelis išlaiko jūsų sistemą greitą ir reaguojančią, o sunkus apdorojimas veikia atskirai. Jei norite suprasti, kaip šis modelis taikomas plačiau, parodo, kaip „webhooks“ gali automatizuoti darbo eigą daugelyje inžinerinių naudojimo atvejų, o ne tik pateikimo portaluose. Webhooks naudojimas automatizavimui Secure Grader Access Studentai neturėtų gauti viešų, nuolatinių nuorodų į studentų pateikimus. Failai turėtų būti prieinami tik ribotą laiką ir tik įgaliotiems vartotojams. Filestack palaiko ribotą laiką, politikos pagrindu prieigos nuorodas.Tai reiškia, kad galite sukurti saugų URL, kuris veikia trumpą laiką, pavyzdžiui, vieną valandą, ir tada automatiškai baigiasi. Štai paprastas pavyzdys: const generateSecureGraderLink = (fileHandle, graderId) => {
  const policy = {
    expiry: Math.floor(Date.now() / 1000) + 3600, // 1-hour access
    handle: fileHandle,
    call: ['read'],
  };

  const encodedPolicy = btoa(JSON.stringify(policy));
  const signature = hmacSha256(encodedPolicy, YOUR_APP_SECRET);

  return `https://cdn.filestackcontent.com/${fileHandle}` +
        `?policy=${encodedPolicy}&signature=${signature}`;
};
 What this does: Sukuria politiką, leidžiančią skaityti prieigą. Nustatykite galiojimo laiką (1 valanda šiuo atveju). Pasirašykite užklausą saugiai naudodami savo programos paslaptį. sukuria laikiną prieigos nuorodą. Gradientas gauna nuorodą, kuri veikia vieną valandą.Po to ji automatiškai nustoja veikti. Tai užkerta kelią nuolatinei visuomenės prieigai prie pateiktų pranešimų ir pašalina poreikį valdyti sudėtingas saugojimo taisykles arba rankiniu būdu ištrinti nuorodą. Atlikus įkėlimą, apdorojimą ir prieigą, jūsų inžinieriai pagaliau gali laisvai sutelkti dėmesį į tai, kas iš tikrųjų svarbu. What Your Team Actually Builds Ką jūsų komanda iš tikrųjų kuria Kai failų tvarkymas yra valdomas "Filestack", jūsų inžinieriai gali sutelkti dėmesį į dalis, kurios tikrai svarbios, funkcijas, kurios daro jūsų portalą skirtingą. Užduočių gyvavimo ciklas: užduočių kūrimas, jų skelbimas, terminų nustatymas, pavėluotų pateikimų tvarkymas, skyrių pridėjimas, tai yra pagrindinė produkto logika. Vartotojo vaidmenys ir teises: Valdyti instruktorius, mokymo padėjėjus, studentus ir administratorius. Apibrėžti, kas gali pateikti, įvertinti, redaguoti ar peržiūrėti turinį. Gradebook: Rezultatai, pridedant atsiliepimus, anotacijas, reitingų skaičiavimus, eksportą, tai kur tikroji vertė yra sukurta vartotojams. Plagiato integracija: Jei jums reikia prisijungti prie paslaugų, pvz., Turnitin ar panašių įrankių, ši integracija gyvena jūsų galinėje pusėje. Tai yra prasmingi inžineriniai iššūkiai, kurie pagerina jūsų produktą. Pažiūrėkime, kaip visa tai veikia kartu realiame pateikimo sraute. A Real Submission Flow, End to End Tikras pateikimo srautas, pabaiga iki pabaigos Padarykime tai praktišku. Instruktorius sukuria projektą, kuris reikalauja: Kodų archyvas (ZIP) Rašytinė ataskaita (PDF arba DOC) Screenshots palaikymas Studentai atidaro pateikimo formą. Jie vilkite ir nuleiskite failus arba importuoti juos iš "Google" disko. Failų rinkiklis tikrina failų tipus ir įgyvendina 500 MB ribą naršyklėje prieš pradedant įkelti. Tada failai perkeliami į „Filestack“. Automatiškai veikia apdorojimo darbo eiga: Viruso nuskaitymo užbaigimas DOC failų konvertavimas į PDF Vaizdai suspausti ir optimizuoti Kai apdorojimas baigiasi, jūsų „webhook“ galinis taškas gauna pranešimą. „Backend“ atnaujina duomenų bazės pateikimo įrašą ir siunčia gradientui saugią, ribotą laiką turinčią prieigos nuorodą. Gradientas atidaro pateikimą ir mato: Tinkamai suformatuoti dokumentai Optimizuoti vaizdai Saugi prieiga Be jokių formatų painiavos, saugumo problemų ar vėlyvo nakties infrastruktūros problemų per egzaminų savaitę. Nuo architektūros sprendimo iki visiškos integracijos, tai yra realistiškai vienos dienos įgyvendinimas patyrusiam inžinieriui. Jei jūsų komanda tikisi didelio srauto ar didelio turto, didelių failų įkėlimo vadove paaiškinama, kaip patikimai tvarkyti didelius failus. Conclusion Komandos, kurios greitai paleidžia pateikimo portalus, neperžengia žingsnių ar sumažina kokybę.Jie juda greičiau, nes jie daro protingą architektūrinį pasirinkimą: jie patys kuria pagrindines funkcijas ir naudoja API sudėtingai infrastruktūrai. Saugiai, patikimai ir dideliu mastu tvarkyti failus gamybos sistemoje yra didelis darbas, jei viską statysite nuo nulio. bet kai naudojate API, tai tampa daug lengviau. Vietoj sudėtingų sistemų kūrimo ir priežiūros, jūs tiesiog sukuriate tai, ko jums reikia. Sprendimas yra paprastas: praleiskite laiką kuriant funkcijas, kurios daro jūsų produktą ypatingą, o ne atkurti failų tvarkymą. This article was published on the  Filosofijos blogas . Šis straipsnis buvo paskelbtas ant Filosofijos blogas Filosofijos blogas .

2022 - HackerNoon Contributor of the Year - Api

Learn More

Nominated for 2022 - HackerNoon Contributor of the Year - Api

Šis garso įrašas sukurtas originalia istorijos kalba!

Inžinerijos komandos gali pristatyti užduočių pateikimo portalus per valandas: kaip jūs galite tai padaryti

About Author

KOMENTARAI

PABAIGTI ŽYMES

ŠIS STRAIPSNIS BUVO PRISTATYMAS

Related Stories

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps