aws / aws/aws-sdk-java-v2

Don't download 200MB of JS for a JavaDoc search feature that most people don't use

Aperta
#5,274 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
documentation p2
Lingua principale
Java
Stelle
2.6k
Fork
1k
Merge medio
2g 9h
PR unite (30g)
51

Descrizione

### Upcoming End-of-Support

- [X] I acknowledge the upcoming end-of-support for AWS SDK for Java v1 was [announced](https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-aws-sdk-for-java-v1-x-on-december-31-2025/), and migration to AWS SDK for Java v2 is recommended.

### Describe the issue

When visiting https://sdk.amazonaws.com/java/api/2.25.67/software/amazon/awssdk/regions/providers/DefaultAwsRegionProviderChain.html

I observed that the loading spinner on the tab seemingly spun forever. After looking at the network tab, I saw it was downloading this: https://sdk.amazonaws.com/java/api/2.25.67/member-search-index.js

It's 216MB of JS... I'm pretty sure this file is generated by the default JavaDoc tool. It's a search index which I think is only useful when using the top-right search box, which I never use anyway.

I don't know whether Chrome refuses to cache it because it's so massive, or cache headers are not set properly, but every single page requests it from scratch.

The type search at https://sdk.amazonaws.com/java/api/2.25.67/type-search-index.js is also 17MB which is less horrendous, and at least that one gets cached, but that is still too much to download.

For now, I blocked this URL `https://sdk.amazonaws.com/*search-index.js` in my ad blocker

### Links

https://sdk.amazonaws.com/java/api/2.25.67/software/amazon/awssdk/regions/providers/DefaultAwsRegionProviderChain.html

As well as every single page

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia dalla pagina collegata DefaultAwsRegionProviderChain.html e ispeziona le sue richieste per member-search-index.js e type-search-index.js. Traccia il modo in cui il sito JavaDoc genera o serve questi indici, quindi verifica che le pagine ordinarie evitino download non necessari, mentre la ricerca in alto a destra continui a funzionare e le risorse memorizzate nella cache siano gestite correttamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java, javascript
Ambito
documentation, performance
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.