AAPT1 Compatibility (#1067)

samtstern · web-flow · commit b087b4f91c15 · 2017-12-20T17:19:21.000-08:00
diff --git a/app/src/main/res/layout/activity_chat.xml b/app/src/main/res/layout/activity_chat.xml
@@ -20,7 +20,7 @@
         android:layout_alignParentStart="true"
         android:layout_alignParentLeft="true"
         android:layout_alignParentTop="true"
-        android:layout_above="@id/footer"
+        android:layout_above="@+id/footer"
         android:clipToPadding="false"
         android:padding="16dp"
         tools:listitem="@layout/message" />
diff --git a/app/src/main/res/layout/activity_chooser_item.xml b/app/src/main/res/layout/activity_chooser_item.xml
@@ -28,9 +28,9 @@
             android:id="@+id/text2"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
-            android:layout_alignStart="@id/text1"
-            android:layout_alignLeft="@id/text1"
-            android:layout_below="@id/text1"
+            android:layout_alignStart="@+id/text1"
+            android:layout_alignLeft="@+id/text1"
+            android:layout_below="@+id/text1"
             android:textAppearance="?android:attr/textAppearanceListItem"
             android:textIsSelectable="false" />
 
diff --git a/app/src/main/res/layout/message.xml b/app/src/main/res/layout/message.xml
@@ -51,9 +51,9 @@
         android:id="@+id/right_arrow"
         android:layout_width="50dp"
         android:layout_height="50dp"
-        android:layout_alignEnd="@id/message"
+        android:layout_alignEnd="@+id/message"
         android:layout_marginEnd="25dp"
-        android:layout_alignRight="@id/message"
+        android:layout_alignRight="@+id/message"
         android:layout_marginRight="25dp"
         android:layout_alignParentTop="true"
         android:background="@drawable/ic_chat_message_arrow"
diff --git a/auth/build.gradle b/auth/build.gradle
@@ -56,6 +56,8 @@ dependencies {
     testImplementation 'org.robolectric:robolectric:3.5.1'
     testImplementation 'com.facebook.android:facebook-login:4.28.0'
     testImplementation("com.twitter.sdk.android:twitter-core:3.1.1@aar") { transitive = true }
+
+    lintChecks project(':lint')
 }
 
 javadoc.include([
diff --git a/auth/src/main/res/layout-land/fui_auth_method_picker_layout.xml b/auth/src/main/res/layout-land/fui_auth_method_picker_layout.xml
@@ -13,7 +13,7 @@
         android:id="@+id/logo"
         style="@style/FirebaseUI.AuthMethodPicker.Logo"
         app:layout_constraintStart_toStartOf="parent"
-        app:layout_constraintEnd_toStartOf="@id/container"
+        app:layout_constraintEnd_toStartOf="@+id/container"
         app:layout_constraintTop_toTopOf="parent"
         app:layout_constraintBottom_toBottomOf="parent"
         tools:ignore="ContentDescription" />  <!-- TODO remove once the bug is fixed: https://issuetracker.google.com/issues/38281866-->
diff --git a/auth/src/main/res/layout/fui_auth_method_picker_layout.xml b/auth/src/main/res/layout/fui_auth_method_picker_layout.xml
@@ -15,7 +15,7 @@
         app:layout_constraintStart_toStartOf="parent"
         app:layout_constraintEnd_toEndOf="parent"
         app:layout_constraintTop_toTopOf="parent"
-        app:layout_constraintBottom_toTopOf="@id/container"
+        app:layout_constraintBottom_toTopOf="@+id/container"
         tools:ignore="ContentDescription" /> <!-- TODO remove once the bug is fixed: https://issuetracker.google.com/issues/38281866-->
 
     <ScrollView
diff --git a/auth/src/main/res/layout/fui_confirmation_code_layout.xml b/auth/src/main/res/layout/fui_confirmation_code_layout.xml
@@ -25,15 +25,15 @@
             android:layout_height="wrap_content"
             android:textAppearance="?android:attr/textAppearanceMedium"
             android:textColor="@color/fui_linkColor"
-            app:layout_constraintTop_toBottomOf="@id/header"
+            app:layout_constraintTop_toBottomOf="@+id/header"
             tools:ignore="SelectableText" />
 
         <android.support.design.widget.TextInputLayout
             android:id="@+id/confirmation_code_layout"
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:layout_marginBottom="@dimen/fui_field_padding_vert"
-            app:layout_constraintTop_toBottomOf="@id/edit_phone_number">
+            app:layout_constraintTop_toBottomOf="@+id/edit_phone_number">
 
             <com.firebase.ui.auth.ui.phone.SpacedEditText
                 android:id="@+id/confirmation_code"
@@ -57,7 +57,7 @@
             style="@style/FirebaseUI.VerifyPhoneButton"
             android:layout_gravity="end"
             android:text="@string/fui_continue_phone_login"
-            app:layout_constraintTop_toBottomOf="@id/confirmation_code_layout" />
+            app:layout_constraintTop_toBottomOf="@+id/confirmation_code_layout" />
 
         <TextView
             android:id="@+id/ticker"
@@ -71,7 +71,7 @@
             android:textIsSelectable="false"
             app:layout_constraintStart_toStartOf="parent"
             app:layout_constraintEnd_toEndOf="parent"
-            app:layout_constraintTop_toBottomOf="@id/submit_confirmation_code"
+            app:layout_constraintTop_toBottomOf="@+id/submit_confirmation_code"
             tools:text="Resend in 0:01" />
 
         <TextView
@@ -86,7 +86,7 @@
             android:visibility="gone"
             app:layout_constraintStart_toStartOf="parent"
             app:layout_constraintEnd_toEndOf="parent"
-            app:layout_constraintTop_toTopOf="@id/ticker"
+            app:layout_constraintTop_toTopOf="@+id/ticker"
             tools:text="Resend code" />
 
         <android.support.constraint.Barrier
@@ -103,7 +103,7 @@
             android:layout_height="wrap_content"
             android:layout_marginTop="@dimen/fui_field_padding_vert"
             android:textIsSelectable="false"
-            app:layout_constraintTop_toBottomOf="@id/tos_barrier"
+            app:layout_constraintTop_toBottomOf="@+id/tos_barrier"
             tools:text="@string/fui_create_account_preamble_tos_and_pp" />
 
     </android.support.constraint.ConstraintLayout>
diff --git a/auth/src/main/res/layout/fui_phone_layout.xml b/auth/src/main/res/layout/fui_phone_layout.xml
@@ -13,14 +13,14 @@
             android:id="@+id/country_list"
             style="@style/FirebaseUI.CountrySpinner"
             app:layout_constraintStart_toStartOf="parent"
-            app:layout_constraintBaseline_toBaselineOf="@id/phone_layout" />
+            app:layout_constraintBaseline_toBaselineOf="@+id/phone_layout" />
 
         <com.firebase.ui.auth.util.ui.BaselineTextInputLayout
             android:id="@+id/phone_layout"
             style="@style/FirebaseUI.TextInputLayout.PhoneField"
             android:layout_width="0dp"
             android:layout_height="wrap_content"
-            app:layout_constraintStart_toEndOf="@id/country_list"
+            app:layout_constraintStart_toEndOf="@+id/country_list"
             app:layout_constraintEnd_toEndOf="parent"
             app:layout_constraintTop_toTopOf="parent">
 
@@ -36,7 +36,7 @@
             style="@style/FirebaseUI.VerifyPhoneButton"
             android:layout_marginTop="@dimen/fui_field_padding_vert"
             android:text="@string/fui_verify_phone_number"
-            app:layout_constraintTop_toBottomOf="@id/phone_layout" />
+            app:layout_constraintTop_toBottomOf="@+id/phone_layout" />
 
         <TextView
             android:id="@+id/send_sms_tos"
@@ -46,7 +46,7 @@
             android:layout_marginTop="@dimen/fui_field_padding_vert"
             android:textColor="?android:textColorTertiary"
             android:textIsSelectable="false"
-            app:layout_constraintTop_toBottomOf="@id/send_code" />
+            app:layout_constraintTop_toBottomOf="@+id/send_code" />
 
     </android.support.constraint.ConstraintLayout>
 
diff --git a/auth/src/main/res/layout/fui_welcome_back_password_prompt_layout.xml b/auth/src/main/res/layout/fui_welcome_back_password_prompt_layout.xml
@@ -24,7 +24,7 @@
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:textIsSelectable="false"
-            app:layout_constraintTop_toBottomOf="@id/heading"
+            app:layout_constraintTop_toBottomOf="@+id/heading"
             tools:text="@string/fui_welcome_back_password_prompt_body" />
 
         <android.support.design.widget.TextInputLayout
@@ -33,7 +33,7 @@
             android:layout_width="match_parent"
             android:layout_height="wrap_content"
             android:layout_marginTop="@dimen/fui_field_padding_vert"
-            app:layout_constraintTop_toBottomOf="@id/welcome_back_password_body"
+            app:layout_constraintTop_toBottomOf="@+id/welcome_back_password_body"
             app:passwordToggleEnabled="true">
 
             <android.support.design.widget.TextInputEditText
@@ -50,16 +50,16 @@
             android:layout_marginTop="@dimen/fui_field_padding_vert"
             android:text="@string/fui_trouble_signing_in"
             app:layout_constraintStart_toStartOf="parent"
-            app:layout_constraintEnd_toStartOf="@id/button_done"
-            app:layout_constraintTop_toBottomOf="@id/password_layout" />
+            app:layout_constraintEnd_toStartOf="@+id/button_done"
+            app:layout_constraintTop_toBottomOf="@+id/password_layout" />
 
         <Button
             android:id="@+id/button_done"
             style="@style/FirebaseUI.Button"
             android:text="@string/fui_sign_in_default"
-            app:layout_constraintStart_toEndOf="@id/trouble_signing_in"
+            app:layout_constraintStart_toEndOf="@+id/trouble_signing_in"
             app:layout_constraintEnd_toEndOf="parent"
-            app:layout_constraintTop_toTopOf="@id/trouble_signing_in" />
+            app:layout_constraintTop_toTopOf="@+id/trouble_signing_in" />
 
     </android.support.constraint.ConstraintLayout>
 
diff --git a/lint/build.gradle b/lint/build.gradle
@@ -0,0 +1,17 @@
+apply plugin: 'java-library'
+
+configurations {
+    lintChecks
+}
+
+dependencies {
+    compileOnly 'com.android.tools.lint:lint-api:26.0.1'
+    compileOnly 'com.android.tools.lint:lint-checks:26.0.1'
+}
+
+
+jar {
+    manifest {
+        attributes('Lint-Registry-v2': 'com.firebaseui.lint.LintIssueRegistry')
+    }
+}
diff --git a/lint/src/main/java/com/firebaseui/lint/LintIssueRegistry.java b/lint/src/main/java/com/firebaseui/lint/LintIssueRegistry.java
@@ -0,0 +1,19 @@
+package com.firebaseui.lint;
+
+import com.android.tools.lint.client.api.IssueRegistry;
+import com.android.tools.lint.detector.api.Issue;
+
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Registry for custom FirebaseUI lint checks.
+ */
+public class LintIssueRegistry extends IssueRegistry {
+
+    @Override
+    public List<Issue> getIssues() {
+        return Collections.singletonList(NonGlobalIdDetector.NON_GLOBAL_ID);
+    }
+
+}
diff --git a/lint/src/main/java/com/firebaseui/lint/NonGlobalIdDetector.java b/lint/src/main/java/com/firebaseui/lint/NonGlobalIdDetector.java
@@ -0,0 +1,84 @@
+package com.firebaseui.lint;
+
+import com.android.resources.ResourceFolderType;
+import com.android.tools.lint.detector.api.Category;
+import com.android.tools.lint.detector.api.Implementation;
+import com.android.tools.lint.detector.api.Issue;
+import com.android.tools.lint.detector.api.ResourceXmlDetector;
+import com.android.tools.lint.detector.api.Scope;
+import com.android.tools.lint.detector.api.Severity;
+import com.android.tools.lint.detector.api.XmlContext;
+
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.NamedNodeMap;
+import org.w3c.dom.Node;
+import org.w3c.dom.NodeList;
+
+import java.util.Collection;
+
+/**
+ * Lint detector to find layout attributes that reference "@id" where they should reference
+ * "@+id" instead.
+ */
+public class NonGlobalIdDetector extends ResourceXmlDetector {
+
+    private static final String NON_GLOBAL_ID_PREFIX = "@id";
+
+    private static final String REPORT_MESSAGE = "Use of non-global @id in layout file, " +
+            "consider using @+id instead for compatibility with aapt1.";
+
+    public static final Issue NON_GLOBAL_ID = Issue.create(
+            "NonGlobalIdInLayout",
+            "Usage of non-global @id in layout file.",
+            "To maintain compatibility with aapt1, it is safer to always use @+id in layout files.",
+            Category.CORRECTNESS,
+            8,
+            Severity.ERROR,
+            new Implementation(NonGlobalIdDetector.class, Scope.ALL_RESOURCES_SCOPE)
+    );
+
+    @Override
+    public boolean appliesTo(ResourceFolderType folderType) {
+        // Only check layout XML files
+        return ResourceFolderType.LAYOUT == folderType;
+    }
+
+    @Override
+    public Collection<String> getApplicableElements() {
+        // Returning null here and in getApplicableAttributes causes visitDocument to be called.
+        return null;
+    }
+
+    @Override
+    public Collection<String> getApplicableAttributes() {
+        // Returning null here and in getApplicableElements causes visitDocument to be called.
+        return null;
+    }
+
+    @Override
+    public void visitDocument(XmlContext context, Document document) {
+        // Visit every node in the document
+        NodeList nodeList = document.getElementsByTagName("*");
+        for (int i = 0; i < nodeList.getLength(); i++) {
+            Node node = nodeList.item(i);
+            if (node.getNodeType() == Node.ELEMENT_NODE) {
+                Element element = (Element) node;
+                checkElement(context, element);
+            }
+        }
+    }
+
+    private void checkElement(XmlContext context, Element element) {
+        NamedNodeMap namedNodeMap = element.getAttributes();
+        for (int i = 0; i < namedNodeMap.getLength(); i++) {
+            Node node = namedNodeMap.item(i);
+            String value = node.getNodeValue();
+
+            // Check if any attribute of the element starts with the @id prefix
+            if (value.contains(NON_GLOBAL_ID_PREFIX)) {
+                context.report(NON_GLOBAL_ID, element, context.getLocation(node), REPORT_MESSAGE);
+            }
+        }
+    }
+}
diff --git a/settings.gradle b/settings.gradle
@@ -1 +1 @@
-include ':app', ':library', ':database', ':auth', ':storage', ':firestore', ':common'
+include ':app', ':library', ':database', ':auth', ':storage', ':firestore', ':common', ':lint'

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,8 @@ dependencies {`
`56`	`56`	`testImplementation 'org.robolectric:robolectric:3.5.1'`
`57`	`57`	`testImplementation 'com.facebook.android:facebook-login:4.28.0'`
`58`	`58`	`testImplementation("com.twitter.sdk.android:twitter-core:3.1.1@aar") { transitive = true }`
	`59`	`+`
	`60`	`+ lintChecks project(':lint')`
`59`	`61`	`}`
`60`	`62`
`61`	`63`	`javadoc.include([`