AppiumDriverLocalService.addLogMessageConsumer(Consumer<String>) supply garbled characters in chinese words , 中文字符乱码 #1617

Activity

1. jasonjiang9527 commented on Dec 24, 2021

   

   jasonjiang9527

   on Dec 24, 2021

   ContributorAuthor

   More actions

   I debug this method , and i fixed it.
   this is because the method used the wrong way to collect the byte[].
   it collect byte[] as char[] within StringBuilder.write(char) and StringBuilder.toString() use String(char[],int,int) , but the correct way is to use OutputStream.write(byte) such as ByteArrayOutputStream.write(byte) and ByteArrayOutputStream.toString()

   public void addLogMessageConsumer(Consumer<String> consumer) {
           checkNotNull(consumer, "consumer parameter is NULL!");
           addOutPutStream(new OutputStream() {
               StringBuilder lineBuilder = new StringBuilder();
   
               @Override
               public void write(int chr) {
                   try {
                       //collect byte as char 
                       lineBuilder.append((char) chr);
                        // lineBuilder.toString() use String(char[],int,int)
                       Matcher matcher = LOG_MESSAGE_PATTERN.matcher(lineBuilder.toString());
                       if (matcher.matches()) {
                           consumer.accept(matcher.group(1));
                           lineBuilder = new StringBuilder();
                       }
                   } catch (Exception e) {
                       // log error and continue
                       LOG.warn("Log message consumer crashed!", e);
                   }
               }
           });
       }
   

   here is a demo show that how char[] and byte[] is totally different

           String wrong = "￥ﾏﾑ\uFFE7ﾎﾰ";
           System.out.println("wrong = " + wrong);
           final ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
           for (char c : wrong.toCharArray()) {
               outputStream.write(c);
           }
           final String correct = outputStream.toString();
           System.out.println("correct = " + correct);
   

   output is

   wrong = ￥ﾏﾑ￧ﾎﾰ
   correct = 发现
   

   also it is easy to avoid this without change the version of appium, just instead of AppiumDriverLocalService.addLogMessageConsumer(Consumer<String>) with appiumDriverLocalService.addOutPutStream(OutputStream)

   appiumDriverLocalServiceInstance.addOutPutStream(new OutputStream() {
               private ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
   
               @Override
               public void write(int chr) {
                   try {
                       byteArrayOutputStream.write(chr);
                       if ((chr == '\n')) {
                           log.info("appium log :", byteArrayOutputStream.toString());
                           byteArrayOutputStream.reset();
                       }
                   } catch (Exception e) {
                       // TODO: 2021/12/24  
                   }
               }
           });
   
2. jasonjiang9527

   changed the title [-]AppiumDriverLocalService.addLogMessageConsumer(Consumer<String>) supply garbled characters in chinese words[/-] [+]AppiumDriverLocalService.addLogMessageConsumer(Consumer<String>) supply garbled characters in chinese words , 中文字符乱码[/+] on Dec 24, 2021
3. mykola-mokhnach commented on Dec 24, 2021

   

   mykola-mokhnach

   on Dec 24, 2021

   Contributor

   More actions

   Thanks for creating the patch. I've added a couple of comments there
4. mykola-mokhnach

   closed this as completedin #1618on Dec 27, 2021
5. mykola-mokhnach

   added a commit that references this issue on Dec 27, 2021

   fix: chinese garbled characters #1617 (#1618)

   1c28134