sonatype-lift[bot] commented on code in PR #10157: URL: https://github.com/apache/skywalking/pull/10157#discussion_r1048550428
########## oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/storage/StorageID.java: ########## @@ -0,0 +1,159 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + */ + +package org.apache.skywalking.oap.server.core.storage; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Optional; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import org.apache.skywalking.oap.server.library.util.StringUtil; + +/** + * StorageID represents an identification for the metric or the record. + * Typically, an ID is composited by two parts + * 1. Time bucket based on downsampling. + * 2. The encoded entity ID, such as Service ID. + * + * In the SQL database and ElasticSearch, the string ID is preferred. + * In the BanyanDB, time series and entity ID(series ID) would be treated separately. + * + * @since 9.4.0 StorageID replaced the `string id()` method in the StorageData. An object-oriented ID provides a more + * friendly interface for various database implementation. + */ +@EqualsAndHashCode(of = { + "fragments" +}) +public class StorageID { + private final List<Fragment> fragments; + /** + * Once the storage ID was {@link #build()} or {@link #read()}, + * this object would switch to the sealed status, no more append is allowed. + */ + private boolean sealed = false; + + public StorageID() { + fragments = new ArrayList<>(2); + } + + public StorageID append(String name, String value) { + if (StringUtil.isBlank(name)) { + throw new IllegalArgumentException("The name of storage ID should not be null or empty."); + } + if (sealed) { + throw new IllegalStateException("The storage ID is sealed. Can't append a new fragment, name=" + name); + } + fragments.add(new Fragment(name, String.class, false, value)); + return this; + } + + public StorageID append(String name, long value) { + if (StringUtil.isBlank(name)) { + throw new IllegalArgumentException("The name of storage ID should not be null or empty."); + } + if (sealed) { + throw new IllegalStateException("The storage ID is sealed. Can't append a new fragment, name=" + name); + } + fragments.add(new Fragment(name, Long.class, false, value)); + return this; + } + + public StorageID append(String name, int value) { + if (StringUtil.isBlank(name)) { + throw new IllegalArgumentException("The name of storage ID should not be null or empty."); + } + if (sealed) { + throw new IllegalStateException("The storage ID is sealed. Can't append a new fragment, name=" + name); + } + fragments.add(new Fragment(name, Integer.class, false, value)); + return this; + } + + public StorageID appendMutant(String source, long value) { + if (sealed) { + throw new IllegalStateException("The storage ID is sealed. Can't append a new fragment, source=" + source); + } + fragments.add(new Fragment(source, Long.class, true, value)); + return this; + } + + public StorageID appendMutant(final String source, final String value) { + if (sealed) { + throw new IllegalStateException("The storage ID is sealed. Can't append a new fragment, source=" + source); + } + fragments.add(new Fragment(source, String.class, true, value)); + return this; + } + + /** + * @return the string ID concatenating the values of {@link #fragments} by the underline(_). + */ + public String build() { + sealed = true; + String[] idParts = new String[fragments.size()]; + for (int i = 0; i < fragments.size(); i++) { + idParts[i] = fragments.get(i).toString(); + } + return StringUtil.join('_', idParts); + } + + /** + * @return a read-only list to avoid unexpected change for metric ID. + */ + public List<Fragment> read() { + sealed = true; + return Collections.unmodifiableList(fragments); + } + + @RequiredArgsConstructor + @Getter + @EqualsAndHashCode(of = { + "name", + "value" + }) + public class Fragment { Review Comment: *[ClassCanBeStatic](https://errorprone.info/bugpattern/ClassCanBeStatic):* Inner class is non-static but does not reference enclosing class --- ```suggestion public static class Fragment { ``` --- <details><summary><b>âšī¸ Learn about @sonatype-lift commands</b></summary> You can reply with the following commands. For example, reply with ***@sonatype-lift ignoreall*** to leave out all findings. | **Command** | **Usage** | | ------------- | ------------- | | `@sonatype-lift ignore` | Leave out the above finding from this PR | | `@sonatype-lift ignoreall` | Leave out all the existing findings from this PR | | `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file | **Note:** When talking to LiftBot, you need to **refresh** the page to see its response. <sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) to add LiftBot to another repo.</sub></details> --- Was this a good recommendation? [ [đ Not relevant](https://www.sonatype.com/lift-comment-rating?comment=361151546&lift_comment_rating=1) ] - [ [đ Won't fix](https://www.sonatype.com/lift-comment-rating?comment=361151546&lift_comment_rating=2) ] - [ [đ Not critical, will fix](https://www.sonatype.com/lift-comment-rating?comment=361151546&lift_comment_rating=3) ] - [ [đ Critical, will fix](https://www.sonatype.com/lift-comment-rating?comment=361151546&lift_comment_rating=4) ] - [ [đ Critical, fixing now](https://www.sonatype.com/lift-comment-rating?comment=361151546&lift_comment_rating=5) ] -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
