Anpassade regler för kodkvalitet

Den här sidan beskriver de anpassade regler för kodkvalitet som körs av Cloud Manager som en del av kodkvalitetstestning. De bygger på god praxis från Experience Manager Engineering.

SonarQube-regler

Följande avsnitt innehåller information om SonarQube-regler som körs av Cloud Manager.

Använd inte potentiellt farliga funktioner

• Nyckel: CQRules:CWE-676
• Typ: Sårbarhet
• Allvarlighetsgrad: Större
• Sedan: Version 2018.4.0

Metoderna Thread.stop() och Thread.interrupt() kan ge upphov till problem som inte går att reproducera och ibland även säkerhetsluckor. Deras användning bör övervakas noggrant och valideras. I allmänhet är meddelandeöverföring ett säkrare sätt att uppnå samma sak.

Kod som inte uppfyller kraven

public class DontDoThis implements Runnable {
  private Thread thread;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    thread.stop();  // UNSAFE!
  }

  public void run() {
    while (true) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

Kompatibel kod

public class DoThis implements Runnable {
  private Thread thread;
  private boolean keepGoing = true;

  public void start() {
    thread = new Thread(this);
    thread.start();
  }

  public void stop() {
    keepGoing = false;
  }

  public void run() {
    while (this.keepGoing) {
        somethingWhichTakesAWhileToDo();
    }
  }
}

Använd inte formatsträngar som kan vara externt kontrollerade

• Nyckel: CQRules:CWE-134
• Typ: Sårbarhet
• Allvarlighetsgrad: Större
• Sedan: Version 2018.4.0

Om du använder en formatsträng från en extern källa (t.ex. en begärandeparameter eller ett användargenererat innehåll) kan programmet utsättas för denial of service-attacker. Det finns tillfällen då en formatsträng kan styras externt, men bara tillåts från betrodda källor.

Kod som inte uppfyller kraven

protected void doPost(SlingHttpServletRequest request, SlingHttpServletResponse response) {
  String messageFormat = request.getParameter("messageFormat");
  request.getResource().getValueMap().put("some property", String.format(messageFormat, "some text"));
  response.sendStatus(HttpServletResponse.SC_OK);
}

HTTP-begäranden ska alltid ha socket- och anslutningstimeout

• Nyckel: CQRules:ConnectionTimeoutMechanism
• Typ: Fel
• Allvarlighetsgrad: Kritisk
• Sedan: Version 2018.6.0

När HTTP-begäranden körs inifrån ett Experience Manager-program är det viktigt att se till att rätt tidsgränser är konfigurerade för att undvika onödig trådförbrukning. Tyvärr är standardbeteendet för båda Java™:s standard-HTTP-klient (java.net.HttpUrlConnection) och den vanligaste Apache HTTP Components-klienten är att aldrig timeout, så timeout måste anges explicit. Dessutom bör dessa timeout inte vara längre än 60 sekunder.

Kod som inte uppfyller kraven

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void dontDoThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  HttpClient httpClient = builder.build();

  // do something with the client
}

public void dontDoThisEither() {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

Kompatibel kod

@Reference
private HttpClientBuilderFactory httpClientBuilderFactory;

public void doThis() {
  HttpClientBuilder builder = httpClientBuilderFactory.newBuilder();
  RequestConfig requestConfig = RequestConfig.custom()
    .setConnectTimeout(5000)
    .setSocketTimeout(5000)
    .build();
  builder.setDefaultRequestConfig(requestConfig);

  HttpClient httpClient = builder.build();

  // do something with the client
}

public void orDoThis() {
  URL url = new URL("http://www.google.com");
  URLConnection urlConnection = url.openConnection();
  urlConnection.setConnectTimeout(5000);
  urlConnection.setReadTimeout(5000);

  BufferedReader in = new BufferedReader(new InputStreamReader(
    urlConnection.getInputStream()));

  String inputLine;
  while ((inputLine = in.readLine()) != null) {
    logger.info(inputLine);
  }

  in.close();
}

Stäng alltid ResursResolver-objekt

• Nyckel: CQRules:CQBP-72
• Typ: Kodmeddelande
• Allvarlighetsgrad: Större
• Sedan: Version 2018.4.0

ResourceResolver objekt som hämtas från ResourceResolverFactory förbruka systemresurser. Även om det finns åtgärder för att återkräva dessa resurser när en ResourceResolver används inte längre, det är mer effektivt att uttryckligen stänga alla öppna ResourceResolver objekt genom att anropa close() -metod.

En relativt vanlig missuppfattning är att ResourceResolver objekt som skapats med en befintlig JCR-session ska inte stängas explicit eller så stängs den underliggande JCR-sessionen. Detta är inte fallet. Oavsett hur ResourceResolver öppnas, ska den stängas när den inte längre används. Sedan ResourceResolver implementerar Closeable -gränssnittet kan du också använda try-with-resources syntax i stället för explicit anrop close().

Kod som inte uppfyller kraven

public void dontDoThis(Session session) throws Exception {
  ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
  // do some stuff with the resolver
}

Kompatibel kod

public void doThis(Session session) throws Exception {
  ResourceResolver resolver = null;
  try {
    resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object)session));
    // do something with the resolver
  } finally {
    if (resolver != null) {
      resolver.close();
    }
  }
}

public void orDoThis(Session session) throws Exception {
  try (ResourceResolver resolver = factory.getResourceResolver(Collections.singletonMap("user.jcr.session", (Object) session))){
    // do something with the resolver
  }
}

Använd inte SSLING-serversökvägar för att registrera servlets

• Nyckel: CQRules:CQBP-75
• Typ: Kodmeddelande
• Allvarlighetsgrad: Större
• Sedan: Version 2018.4.0

Enligt beskrivningen i Sling-dokumentation, rekommenderas inte bindningsservrar av sökvägar. Sökvägsbundna servrar kan inte använda vanliga JCR-åtkomstkontroller och därför krävs ytterligare säkerhetsproblem. I stället för att använda sökvägsbundna servrar rekommenderar vi att du skapar noder i databasen och registrerar servlets efter resurstyp.

Kod som inte uppfyller kraven

@Component(property = {
  "sling.servlet.paths=/apps/myco/endpoint"
})
public class DontDoThis extends SlingAllMethodsServlet {
 // implementation
}

Undantag som fångas upp ska loggas eller kastas, inte båda

• Nyckel: CQRules:CQBP-44—CatchAndeitherLogOrThrow
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2018.4.0

I allmänhet bör ett undantag loggas exakt en gång. Om du loggar undantag flera gånger kan det leda till missförstånd eftersom det är oklart hur många gånger ett undantag inträffade. Det vanligaste mönstret som leder till detta är loggning och generering av ett fångat undantag.

Kod som inte uppfyller kraven

public void dontDoThis() throws Exception {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
    throw e;
  }
}

Kompatibel kod

public void doThis() {
  try {
    someOperation();
  } catch (Exception e) {
    logger.error("something went wrong", e);
  }
}

public void orDoThis() throws MyCustomException {
  try {
    someOperation();
  } catch (Exception e) {
    throw new MyCustomException(e);
  }
}

Undvik loggsatser som omedelbart följs av en throw-sats

• Nyckel: CQRules:CQBP-44—ConsecutiousLogAndThrow
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2018.4.0

Ett annat vanligt sätt att undvika är att logga ett meddelande och sedan omedelbart generera ett undantag. Den här proceduren innebär vanligtvis att undantagsmeddelandet kommer att dupliceras i loggfiler.

Kod som inte uppfyller kraven

public void dontDoThis() throws Exception {
  logger.error("something went wrong");
  throw new RuntimeException("something went wrong");
}

Kompatibel kod

public void doThis() throws Exception {
  throw new RuntimeException("something went wrong");
}

Undvik att logga på INFO när du hanterar GET- eller HEAD-förfrågningar

• Nyckel: CQRules:CQBP-44—LogInfoInGetOrHeadRequests
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre

I allmänhet bör INFO-loggnivån användas för att avgränsa viktiga åtgärder och Experience Manager är som standard konfigurerad för att logga på INFO-nivå eller högre. Metoderna GET och HEAD bör aldrig vara skrivskyddade och därför inte utgöra några viktiga åtgärder. Loggning på INFO-nivå som svar på GET- eller HEAD-förfrågningar skapar troligen avsevärt loggbrus, vilket gör det svårare att identifiera användbar information i loggfiler. Loggning vid hantering av GET- eller HEAD-begäranden bör finnas antingen på WARN- eller FEL-nivå när något har gått fel eller på DEBUG- eller TRACE-nivå om mer detaljerad felsökningsinformation skulle vara till hjälp.

Kod som inte uppfyller kraven

public void doGet() throws Exception {
  logger.info("handling a request from the user");
}

Kompatibel kod

public void doGet() throws Exception {
  logger.debug("handling a request from the user.");
}

Använd inte Exception.getMessage() som första parameter i en loggningssats

• Nyckel: CQRules:CQBP-44—ExceptionGetMessageIsFirstLogParam
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2018.4.0

Som en god praxis bör loggmeddelanden innehålla sammanhangsberoende information om var i programmet ett undantag har inträffat. Kontexten kan också bestämmas med stackspår, men i allmänhet blir loggmeddelandet lättare att läsa och förstå. När du loggar ett undantag är det därför en dålig vana att använda undantagets meddelande som loggmeddelande. Undantagsmeddelandet innehåller det som gick fel medan loggmeddelandet bör användas för att tala om för en loggläsare vad programmet gjorde när undantaget inträffade. Undantagsmeddelandet är fortfarande loggat. Genom att ange ett eget meddelande blir loggarna lättare att förstå.

Kod som inte uppfyller kraven

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error(e.getMessage(), e);
  }
}

Kompatibel kod

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

Inloggning av catch-block ska ske på WARN- eller ERROR-nivå

• Nyckel: CQRules:CQBP-44—WrongLogLevelInCatchBlock
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2018.4.0

Som namnet antyder bör Java™-undantag alltid användas i undantagsfall. Därför är det viktigt att loggmeddelanden loggas på lämplig nivå när ett undantag fångas upp, antingen WARN eller ERROR. Detta garanterar att meddelandena visas korrekt i loggarna.

Kod som inte uppfyller kraven

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.debug(e.getMessage(), e);
  }
}

Kompatibel kod

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

Skriv inte ut stackspår till konsolen

• Nyckel: CQRules:CQBP-44—ExceptionPrintStackTrace
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2018.4.0

Som vi nämnt är sammanhang viktigt när du ska förstå loggmeddelanden. Använda Exception.printStackTrace() gör att endast stackspårningen matas ut till standardfelströmmen och förlorar all kontext. Om flera undantag skrivs ut med den här metoden parallellt i ett program med flera trådar, som Experience Manager, kan stackspårningarna överlappa, vilket kan skapa stor förvirring. Undantag bör endast loggas via loggningsramverket.

Kod som inte uppfyller kraven

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    e.printStackTrace();
  }
}

Kompatibel kod

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

Exportera inte till standardutdata eller standardfel

• Nyckel: CQRules:CQBP-44—LogLevelConsolePrinters
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2018.4.0

Loggning i Experience Manager ska alltid ske via loggningsramverket (SLF4J). Om du matar ut direkt till standardutdata eller standardfelströmmar förlorar du den strukturella och kontextuella information som tillhandahålls av loggningsramverket. Ibland kan det orsaka prestandaproblem.

Kod som inte uppfyller kraven

public void dontDoThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    System.err.println("Unable to do something");
  }
}

Kompatibel kod

public void doThis() {
  try {
    someMethodThrowingAnException();
  } catch (Exception e) {
    logger.error("Unable to do something", e);
  }
}

Undvik hårdkodade sökvägar för /appar och /libs

• Nyckel: CQRules:CQBP-71
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2018.4.0

Vanligtvis banor som börjar med /libs och /apps ska inte hårdkodas eftersom de sökvägar de refererar till vanligtvis lagras som sökvägar i förhållande till sökbanan för Sling, som är inställd på /libs,/apps som standard. Om du använder den absoluta sökvägen kan det orsaka subtila defekter som bara skulle visas senare i projektets livscykel.

Kod som inte uppfyller kraven

public boolean dontDoThis(Resource resource) {
  return resource.isResourceType("/libs/foundation/components/text");
}

Kompatibel kod

public void doThis(Resource resource) {
  return resource.isResourceType("foundation/components/text");
}

Använd inte Sling-schemaläggare

• Nyckel: CQRules:AMSCORE-554
• Typ: Kompatibilitet med kodmeddelanden/Cloud Service
• Allvarlighetsgrad: Mindre
• Sedan: Version 2020.5.0

Använd inte Sling Scheduler för aktiviteter som kräver en garanterad körning. Sling Scheduled Jobs garanterar körning och passar bättre för både klustrade och icke-klustrade miljöer.

Se Apache Sling Eventing och Job Handling om du vill veta mer om hur Sling Jobs hanteras i klustrade miljöer.

Använd inte inaktuella API:er från Experience Manager

• Nyckel: AMSCORE-553
• Typ: Kompatibilitet med kodmeddelanden/Cloud Service
• Allvarlighetsgrad: Mindre
• Sedan: Version 2020.5.0

API-ytan i Experience Manager är under ständig revision för att identifiera API:er som inte används och därför betraktas som inaktuella.

Dessa API:er är ofta föråldrade med Java™-standarden @Deprecated anteckning och, som sådan, identifierad av squid:CallToDeprecatedMethod.

Det finns dock fall där en API är inaktuell i Experience Manager men inte kan användas i andra sammanhang. Den här regeln identifierar den andra klassen.

Använd inte @Inject-anteckning med @Optional i Sling-modeller

• Nyckel: InjectAnnotationWithOptionalInjectionCheck
• Typ: Programkvalitet
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.11

Apache Sling-projektet uppmuntrar inte till användning av @Inject anteckning i samband med Sling Models, eftersom den kan leda till sämre prestanda när den kombineras med DefaultInjectionStrategy.OPTIONAL (antingen på fält- eller klassnivå). Istället för mer specifika injektioner (som @ValueMapValue eller @OsgiInjector anteckningar) bör användas.

Kontrollera Dokumentation för Apache Sling för mer information om de rekommenderade anteckningarna och varför den här rekommendationen gjordes från början.

Återanvänd instanser av en HTTPClient

• Nyckel: AEMSRE-870
• Typ: Programkvalitet
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.11

AEM når ofta ut till andra program med HTTP-protokollet, och Apache HttpClient är ett bibliotek som ofta används för att uppnå detta. Men när du skapar ett sådant HttpClient-objekt får du en del overhead, så dessa objekt bör återanvändas så mycket som möjligt.

Den här regeln kontrollerar att ett sådant HttpClient-objekt inte är privat inom en metod, utan globalt på en klassnivå, så att det kan återanvändas. I det här fallet ska fältet httpClient anges i konstruktorn för klassen eller activate() metod (om den här klassen är en OSGi-komponent/tjänst).

Kontrollera Optimeringsguide för HttpClient för några bästa metoder för användning av HttpClient.

Kod som inte uppfyller kraven

public void doHttpCall() {
  HttpClient httpclient = HttpClients.createDefault();
  // do something with the httpclient
}

Kompatibel kod

public class myClass {

  HttpClient httpclient;

  public void doHttpCall() {
    // do something with the httpclient
  }

}

OakPAL-innehållsregler

Följande avsnitt innehåller information om de OakPAL-kontroller som körs av Cloud Manager.

Produkt-API:er som annoterats med @ProviderType ska inte implementeras eller utökas av kunder

• Nyckel: CQBP-84
• Typ: Fel
• Allvarlighetsgrad: Kritisk
• Sedan: Version 2018.7.0

API:t för Experience Manager innehåller Java™-gränssnitt och -klasser som endast är avsedda att användas - men inte implementeras - av anpassad kod. Gränssnittet com.day.cq.wcm.api.Page bör endast genomföras av Experience Manager.

När nya metoder läggs till i dessa gränssnitt påverkar dessa ytterligare metoder inte befintlig kod som använder dessa gränssnitt. Det betyder att tillägg av nya metoder i dessa gränssnitt anses vara bakåtkompatibelt. Men om anpassad kod implementerar ett av dessa gränssnitt har den anpassade koden skapat en risk vad gäller bakåtkompatibilitet för kunden.

Gränssnitt och klasser - som implementerats av Experience Manager - kommenteras med org.osgi.annotation.versioning.ProviderType eller ibland en liknande äldre anteckning aQute.bnd.annotation.ProviderType. Den här regeln identifierar de fall där ett sådant gränssnitt implementeras eller en klass utökas av anpassad kod.

Kod som inte uppfyller kraven

import com.day.cq.wcm.api.Page;

public class DontDoThis implements Page {
// implementation here
}

Anpassade Lucene Oak-index måste ha en Tika-konfiguration

• Nyckel: IndexTikaNode
• Typ: Fel
• Allvarlighetsgrad: Blockerare
• Sedan: 2021.8.0

Flera färdiga Experience Manager Oak-index innehåller en Tika-konfiguration och anpassningar av dessa index måste innehålla en Tika-konfiguration. Den här regeln söker efter anpassningar av damAssetLucene, luceneoch graphqlConfig index och ger upphov till ett problem om tika  noden saknas eller om tika noden saknar en underordnad nod med namnet config.xml.

Se indexeringsdokumentation för mer information om hur du anpassar indexdefinitioner.

Kod som inte uppfyller kraven

+ oak:index
    + damAssetLucene-1-custom
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene

Kompatibel kod

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Egna Lucene-ekindex får inte vara synkrona

• Nyckel: IndexAsyncProperty
• Typ: Fel
• Allvarlighetsgrad: Blockerare
• Sedan: 2021.8.0

Oak-index av typen lucene måste alltid indexeras asynkront. Om du inte gör detta kan det leda till att systemet blir instabilt. Mer information om strukturen i Lucene-index finns i Läs dokumentationen.

Kod som inte uppfyller kraven

+ oak:index
    + damAssetLucene-1-custom
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      - tags: [visualSimilaritySearch]
      + tika
        + config.xml

Kompatibel kod

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Index för anpassade DAM-tillgångar Luceneak är korrekt strukturerade

• Nyckel: IndexDamAssetLucene
• Typ: Fel
• Allvarlighetsgrad: Blockerare
• Sedan: 2021.6.0

För att resurssökningen ska fungera korrekt i Experience Manager Assets måste du anpassa damAssetLucene Oak-indexet måste följa en uppsättning riktlinjer som är specifika för detta index. Den här regeln kontrollerar att indexdefinitionen måste ha en egenskap med flera värden som heter tags som innehåller värdet visualSimilaritySearch.

Kod som inte uppfyller kraven

+ oak:index
    + damAssetLucene-1-custom
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - type: lucene
      + tika
        + config.xml

Kompatibel kod

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: /content/dam
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Kundpaket får inte skapa eller ändra noder under /libs

• Nyckel: BannedPath
• Typ: Fel
• Allvarlighetsgrad: Kritisk
• Sedan: Version 2019.6.0

Det har länge varit en god praxis att /libs innehållsträdet i Experience Manager ska av kunderna betraktas som skrivskyddat. Ändra noder och egenskaper under /libs innebär en betydande risk för större och mindre uppdateringar. Ändringar av /libs måste göras av Adobe via officiella kanaler.

Paket får inte innehålla dubbla OSGi-konfigurationer

• Nyckel: DuplicateOsgiConfigurations
• Typ: Fel
• Allvarlighetsgrad: Större
• Sedan: Version 2019.6.0

Ett vanligt problem som inträffar i komplexa projekt är när samma OSGi-komponent konfigureras flera gånger. Detta skapar en tvetydighet om vilken konfiguration som är tillämplig. Den här regeln är"körningsmedveten" eftersom den bara identifierar problem där samma komponent har konfigurerats flera gånger i samma körningsläge eller en kombination av körningslägen.

Kod som inte uppfyller kraven

+ apps
  + projectA
    + config
      + com.day.cq.commons.impl.ExternalizerImpl
  + projectB
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

Kompatibel kod

+ apps
  + shared-config
    + config
      + com.day.cq.commons.impl.ExternalizerImpl

Konfigurations- och installationsmappar får endast innehålla OSGi-noder

• Nyckel: ConfigAndInstallShouldOnlyContainOsgiNodes
• Typ: Fel
• Allvarlighetsgrad: Större
• Sedan: Version 2019.6.0

Av säkerhetsskäl innehåller sökvägar /config/ och /install/ kan endast läsas av administratörer i Experience Manager och bör endast användas för OSGi-konfigurationer och OSGi-paket. Om du placerar andra typer av innehåll under banor som innehåller dessa segment, kommer programbeteendet att variera oavsiktligt mellan administrativa och icke-administrativa användare.

Ett vanligt problem är att använda namngivna noder config i komponentdialogrutor eller när du anger RTF-redigeringskonfigurationen för infogad redigering. För att lösa det här problemet bör namnet på den felande noden ändras till ett kompatibelt namn. För RTF-redigerarkonfigurationen använder du configPath -egenskapen på cq:inplaceEditing nod som anger den nya platsen.

Kod som inte uppfyller kraven

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    + config [nt:unstructured]
      + rtePlugins [nt:unstructured]

Kompatibel kod

+ cq:editConfig [cq:EditConfig]
  + cq:inplaceEditing [cq:InplaceEditConfig]
    ./configPath = inplaceEditingConfig (String)
    + inplaceEditingConfig [nt:unstructured]
      + rtePlugins [nt:unstructured]

Paket får inte överlappa

• Nyckel: PackageOverlaps
• Typ: Fel
• Allvarlighetsgrad: Större
• Sedan: Version 2019.6.0

Liknar Paket får inte innehålla en dubblettregel för OSGi-konfigurationer, detta är ett vanligt problem i komplexa projekt där samma nodsökväg skrivs av flera separata innehållspaket. Även om beroenden för innehållspaket kan användas för att säkerställa ett konsekvent resultat är det bättre att undvika överlappningar helt och hållet.

Standardredigeringsläget får inte vara ett klassiskt användargränssnitt

• Nyckel: ClassicUIAuthoringMode
• Typ: Kompatibilitet med kodmeddelanden/Cloud Service
• Allvarlighetsgrad: Mindre
• Sedan: Version 2020.5.0

OSGi-konfigurationen com.day.cq.wcm.core.impl.AuthoringUIModeServiceImpl definierar standardredigeringsläget i Experience Manager. Eftersom det klassiska användargränssnittet har tagits bort sedan Experience Manager 6.4, uppstår nu ett problem när standardredigeringsläget är konfigurerat till Classic UI.

Komponenter med dialogrutor bör ha dialogrutor med pekskärmsgränssnitt

• Nyckel: ComponentWithOnlyClassicUIDialog
• Typ: Kompatibilitet med kodmeddelanden/Cloud Service
• Allvarlighetsgrad: Mindre
• Sedan: Version 2020.5.0

Experience Manager-komponenter som har en klassisk användargränssnittsdialogruta bör alltid ha en motsvarande dialogruta för användargränssnittet. Båda ger en optimal redigeringsupplevelse och är kompatibla med Cloud Servicens distributionsmodell, där det klassiska användargränssnittet inte stöds. Den här regeln verifierar följande scenarier:

• En komponent med en klassisk användargränssnittsdialogruta (d.v.s. en dialog underordnad nod) måste ha en motsvarande Touch UI-dialogruta (d.v.s. en cq:dialog underordnad nod).
• En komponent med en klassisk dialogruta för användargränssnittsdesign (dvs. en design_dialog nod) måste ha en motsvarande dialogruta för Touch UI-design (d.v.s. en cq:design_dialog underordnad nod).
• En komponent med både en klassisk användargränssnittsdialogruta och en klassisk dialogruta för användargränssnittsdesign måste ha både en motsvarande dialogruta för användargränssnittet för touchredigering och en motsvarande designdialogruta för användargränssnittet för touchgränssnitt.

Dokumentationen för Experience Manager Moderniseringsverktyg innehåller dokumentation och verktyg för hur du konverterar komponenter från det klassiska användargränssnittet till Touch-användargränssnittet. Se dokumentationen för Experience Manager Modernization Tools för mer information.

Paket får inte innehålla både muterbara och oföränderliga

• Nyckel: ImmutableMutableMixedPackage
• Typ: Kompatibilitet med kodmeddelanden/Cloud Service
• Allvarlighetsgrad: Mindre
• Sedan: Version 2020.5.0

För att vara kompatibel med databasens distributionsmodell måste enskilda innehållspaket innehålla antingen innehåll för databasens oföränderliga Cloud Service (/apps och /libs), eller det muterbara området (allt finns inte i /apps eller /libs), men inte båda. Ett paket som innehåller både /apps/myco/components/text och /etc/clientlibs/myco är inte kompatibelt med Cloud Service och orsakar att ett fel rapporteras.

Se Experience Manager projektstruktur för mer information.

Använd inte agenter för omvänd replikering

• Nyckel: ReverseReplication
• Typ: Kompatibilitet med kodmeddelanden/Cloud Service
• Allvarlighetsgrad: Mindre
• Sedan: Version 2020.5.0

Stöd för omvänd replikering är inte tillgängligt i distributioner av Cloud Service, vilket beskrivs som en del av Experience Manager as a Cloud Service versionsinformation.

Kunder som använder omvänd replikering bör kontakta Adobe för att få alternativa lösningar.

Resurser i proxyaktiverade klientbibliotek bör finnas i en mapp med namnet resources

• Nyckel: ClientlibProxyResource
• Typ: Fel
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Klientbibliotek i Experience Manager kan innehålla statiska resurser som bilder och teckensnitt. Enligt beskrivningen i dokumentet Med preprocessorer, när du använder proxyanslutna klientbibliotek måste dessa statiska resurser finnas i en underordnad mapp med namnet resources att effektivt refereras till i publiceringsinstanser.

Kod som inte uppfyller kraven

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + images
        + myimage.jpg

Kompatibel kod

+ apps
  + projectA
    + clientlib
      - allowProxy=true
      + resources
        + myimage.jpg

Användning av arbetsflödesprocesser som inte är kompatibla med Cloud Service

• Nyckel: CloudServiceIncompatibleWorkflowProcess
• Typ: Fel
• Allvarlighetsgrad: Större
• Sedan: Version 2021.2.0

I och med övergången till tillgångsmikrotjänster för tillgångsbearbetning på Experience Manager as a Cloud Service har flera arbetsflödesprocesser som användes på plats och i AMS-versioner av Experience Manager blivit antingen ostödda eller onödiga.

Migreringsverktyget i Experience Manager as a Cloud Service Assets GitHub-databas kan användas för att uppdatera arbetsflödesmodeller under migrering till Experience Manager as a Cloud Service.

Användning av statiska mallar rekommenderas inte för redigerbara mallar

• Nyckel: StaticTemplateUsage
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Även om det historiskt sett är vanligt att använda statiska mallar i Experience Manager-projekt rekommenderar Adobe redigerbara mallar eftersom de ger den flexibilitet och stöder ytterligare funktioner som inte finns i statiska mallar. Mer information finns i dokumentet Sidmallar.

Migrering från statiska till redigerbara mallar kan till stor del automatiseras med Moderniseringsverktyg för Experience Manager.

Användning av äldre baskomponenter rekommenderas inte

• Nyckel: LegacyFoundationComponentUsage
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

De äldre Foundation Components (d.v.s. komponenter under /libs/foundation) har ersatts av flera Experience Manager-versioner till förmån för kärnkomponenterna. Användning av Foundation Components som grund för anpassade komponenter (oavsett om de är övertäckningar eller arv) rekommenderas inte och bör konverteras till motsvarande Core Components.

Den här konverteringen kan underlättas av Moderniseringsverktyg för Experience Manager.

Använd endast namn och ordning för körningsläge som stöds

• Nyckel: SupportedRunmode
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Experience Manager as a Cloud Service tillämpar en strikt namngivningsprincip för körningslägesnamn och en strikt ordning för dessa körningslägen. En lista över körningslägen som stöds finns i dokumentet Distribuera till Experience Manager as a Cloud Service och alla avvikelser från detta identifieras som en fråga.

Definitionsnoder för anpassade sökindex måste vara direkt underordnade /oak:index

• Nyckel: OakIndexLocation
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Experience Manager as a Cloud Service kräver anpassade sökindexdefinitioner (d.v.s. noder av typen oak:QueryIndexDefinition) be direct child nodes of /oak:index. Index på andra platser måste flyttas för att vara kompatibla med Experience Manager as a Cloud Service. Mer information om sökindex finns i dokumentet Innehållssökning och indexering.

Definitionsnoder för anpassade sökindex måste ha en compatVersion av 2

• Nyckel: IndexCompatVersion
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Experience Manager as a Cloud Service kräver anpassade sökindexdefinitioner (till exempel noder av typen oak:QueryIndexDefinition) måste ha compatVersion egenskap inställd på 2. Alla andra värden stöds inte av Experience Manager as a Cloud Service. Mer information om sökindex finns på Innehållssökning och indexering.

Underordnade noder för anpassade sökindexdefinitionsnoder måste vara av typen nt:undefined

• Nyckel: IndexDescendantNodeType
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Det är svårt att felsöka problem när en anpassad sökindexdefinitionsnod har oordnade underordnade noder. För att undvika detta rekommenderar vi att alla underordnade noder i en oak:QueryIndexDefinition noden är av typen nt:unstructured.

Definitionsnoder för anpassade sökindex måste innehålla en underordnad nod med namnet indexRules som har underordnade noder

• Nyckel: IndexRulesNode
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

En korrekt definierad definitionsnod för ett anpassat sökindex måste innehålla en underordnad nod med namnet indexRules som i sin tur måste ha minst ett barn. Mer information finns i Läs dokumentationen.

Definitionsnoder för anpassade sökindex måste följa namnkonventioner

• Nyckel: IndexName
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Experience Manager as a Cloud Service kräver anpassade sökindexdefinitioner (d.v.s. noder av typen oak:QueryIndexDefinition) måste namnges efter ett specifikt mönster som beskrivs i dokumentet Innehållssökning och indexering.

Definitionsnoder för anpassade sökindex måste använda indextypen Lucene

• Nyckel: IndexType
• Typ: Fel
• Allvarlighetsgrad: Blockerare
• Sedan: Version 2021.2.0 (ändrad typ och allvarlighetsgrad 2021.8.0)

Experience Manager as a Cloud Service kräver anpassade sökindexdefinitioner (d.v.s. noder av typen oak:QueryIndexDefinition) har en type egenskap med värdet inställt på lucene. Indexering med äldre indextyper måste uppdateras innan migrering till Experience Manager as a Cloud Service görs. Se Innehållssökning och indexering för mer information.

Definitionsnoder för anpassade sökindex får inte innehålla en egenskap med namnet seed

• Nyckel: IndexSeedProperty
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Experience Manager as a Cloud Service tillåter inte anpassade sökindexdefinitioner (d.v.s. noder av typen oak:QueryIndexDefinition) som innehåller en egenskap med namnet seed. Indexering med den här egenskapen måste uppdateras innan migrering till Experience Manager as a Cloud Service. Se dokumentet Innehållssökning och indexering för mer information.

Definitionsnoder för anpassade sökindex får inte innehålla egenskapen reindex

• Nyckel: IndexReindexProperty
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2021.2.0

Experience Manager as a Cloud Service tillåter inte anpassade sökindexdefinitioner (d.v.s. noder av typen oak:QueryIndexDefinition) som innehåller en egenskap med namnet reindex. Indexering med den här egenskapen måste uppdateras innan migrering till Experience Manager as a Cloud Service. Se dokumentet Innehållssökning och indexering för mer information.

Anpassade DAM-resursklassnoder får inte ange queryPaths

• Nyckel: IndexDamAssetLucene
• Typ: Fel
• Allvarlighetsgrad: Blockerare
• Sedan: Version 2022.1.0

Kod som inte uppfyller kraven

+ oak:index
    + damAssetLucene-1-custom-1
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - queryPaths: [/content/dam]
      - type: lucene
      + tika
        + config.xml

Kompatibel kod

+ oak:index
    + damAssetLucene-1-custom-2
      - async: [async, nrt]
      - evaluatePathRestrictions: true
      - includedPaths: [/content/dam]
      - tags: [visualSimilaritySearch]
      - type: lucene
      + tika
        + config.xml

Om indexdefinitionen för anpassad sökning innehåller compatVersion måste den anges till 2

• Nyckel: IndexCompatVersion
• Typ: Kodmeddelande
• Allvarlighetsgrad: Större
• Sedan: Version 2022.1.0

Indexnoden som anger includedPaths ska även ange queryPaths med samma värden

• Nyckel: IndexIncludedPathsWithoutQueryPaths
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.1.0

För anpassade index gäller båda includedPaths och queryPaths ska konfigureras med identiska värden. Om en anges måste den andra matcha den. Det finns dock ett specialfall för index med damAssetLucene, inklusive anpassade versioner. Därför bör du bara ange includedPaths.

Indexnod som anger nodeScopeIndex för allmän nodtyp ska även ange includedPaths och queryPaths

• Nyckel: IndexFulltextOnGenericType
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.1.0

När du anger nodeScopeIndex egenskap för en "generisk" nodtyp som nt:unstructured eller nt:basemåste du också ange includedPaths och queryPaths egenskaper.
nt:base kan betraktas som"generiskt" eftersom alla nodtyper ärver från det. Så ställa in en nodeScopeIndex på nt:base indexerar alla noder i databasen. På samma sätt nt:unstructured betraktas också som"generiskt" eftersom det finns många noder i databaser av den här typen.

Kod som inte uppfyller kraven

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

Kompatibel kod

+ oak:index/acme.someIndex-custom-1
  - async: [async, nrt]
  - evaluatePathRestrictions: true
  - tags: [visualSimilaritySearch]
  - type: lucene
  - includedPaths: ["/content/dam/"]
  - queryPaths: ["/content/dam/"]
    + indexRules
      - jcr:primaryType: nt:unstructured
      + nt:base
        - jcr:primaryType: nt:unstructured
        + properties
          + acme.someIndex-custom-1
            - nodeScopeIndex: true

Egenskapen queryLimitReads för frågemotorn ska inte åsidosättas

• Nyckel: OverrideOfQueryLimitReads
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.1.0

Om du åsidosätter standardvärdet kan det leda till mycket långsam sidläsning, särskilt när mer innehåll läggs till.

Flera aktiva versioner av samma index

• Nyckel: IndexDetectMultipleActiveVersionsOfSameIndex
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.1.0

Kod som inte uppfyller kraven

+ oak:index
  + damAssetLucene-1-custom-1
    ...
  + damAssetLucene-1-custom-2
    ...
  + damAssetLucene-1-custom-3
    ...

Kompatibel kod

+ damAssetLucene-1-custom-3
    ...

Namnet på helt anpassade indexdefinitioner bör överensstämma med de officiella riktlinjerna

• Nyckel: IndexValidFullyCustomName
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.1.0

Det förväntade mönstret för helt anpassade indexnamn är: [prefix].[indexName]-custom-[version]. Mer information finns i dokumentet Innehållssökning och indexering.

Samma egenskap med olika analyserade värden i samma indexdefinition

Kod som inte uppfyller kraven

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status

Kompatibel kod

Exempel:

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
        - analyzed: true
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

Exempel:

+ indexRules
  + dam:Asset
    + properties
      + status
        - name: status
  + dam:cfVariationNode
    + properties
      + status
        - name: status
        - analyzed: true

Om den analyserade egenskapen inte uttryckligen har angetts, kommer standardvärdet att vara false.

Tagg, egenskap

• Nyckel: IndexHasValidTagsProperty
• Typ: Kodmeddelande
• Allvarlighetsgrad: Mindre
• Sedan: Version 2023.1.0

För specifika index måste du behålla taggegenskapen och dess aktuella värden. Det går att lägga till nya värden i taggegenskapen, men om du tar bort befintliga värden (eller egenskapen helt) kan det leda till oväntade resultat.